KILL^%ZTLOAD: Delete a Task

Reference Type: Supported, Category: TaskMan, ICR#: 10063

Description

The KILL^%ZTLOAD API deletes a task. When a task is deleted by KILL^%ZTLOAD, the task referenced by ZTSK is not defined in the volume set's task file. If the task was pending, it does not start, but if it had already started running, the effects of deleting its record are unpredictable.

NOTE: Tasks can delete their own records through the use of the ZTREQ output variable.

Format

  KILL^%ZTLOAD

Make sure to perform the following steps before calling this API:

1. NEW all non-namespaced variables.
   
   
2. Set all input variables.
   
   
3. Call the API.

Input Variables

Output Variables