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

ISQED^%ZTLOAD: Return Task Status

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

Description

The ISQED^%ZTLOAD API returns whether a task is currently pending. Pending means that the task is any of the following:

It also returns the DUZ of the task's creator and the time the task was scheduled to start.

Format

  ISQED^%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) Task number of the task to look up. The task must be currently defined on the volume set to be searched, or the lookup fails.
ZTCPU:

(optional) The volume set TaskMan should search for the task being looked up. If not passed, TaskMan searches the current volume set. Unlike the ^%ZTLOAD API ZTCPU input variable, this one does not accept a second :-piece specifying the CPU. It only specifies a volume set to search.

Output Variables

ZTSK(0):

ZTSK(0) is returned as follows:

  • 1—Task ZTSK is currently scheduled or waiting on volume set ZTCPU.

  • 0—Task ZTSK is not currently scheduled or waiting on volume set ZTCPU.

  • NULL ("")—The lookup was unsuccessful.
ZTSK("E"):

(sometimes returned) The error code, returned when some error condition prevented a successful lookup. The codes and their values are:

  • IT—The task number was not valid (0, negative, or non-numeric).

  • I—The task does not exist on the specified volume set.

  • IS—The volume set is not listed in the VOLUME SET (#14.5) file.

  • LS—The link to that volume set is not available.

  • U—An unexpected error arose (e.g., disk full, protection, etc.).
ZTSK("D"):

(sometimes returned) The date and time the task was scheduled to start, in $HOROLOG format. It is returned only if ZTSK(0) equals zero (0) or 1.
ZTSK("DUZ"):

(sometimes returned) Holds the DUZ of the user who created the task. It is returned only if ZTSK(0) equals zero (0) or 1.