Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

DQ^%ZTLOAD: Unschedule a Task

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

Description

The DQ^%ZTLOAD API unschedules tasks. Unscheduling a task ensures that, after the call, it is not scheduled or waiting for a device, computer link, or partition in memory. Unscheduling is guaranteed to be successful as long as the task is currently defined in the TASKS (#14.4) file. However, unscheduling a task that has already started running does not stop the task in any way.

Format

  DQ^%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

ZTSK:

(required) The number of the task to unschedule. This task must currently be defined in the TASKS (#14.4) file or the call fails.

Output

returns:

Returns:

  • 1—Task was unscheduled successfully.

  • 0—Task was not unscheduled successfully.