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

OPTSTAT^XUTMOPT(): Obtain Option Schedule

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

Description

The OPTSTAT^XUTMOPT API allows an application to find out when a option is scheduled and get other data.

Format

  OPTSTAT^XUTMOPT(option_name,.root)

Input Parameters

option_name:

(required) The name of the option from the OPTION (#19) file upon which to return data.
.root:

(required) This parameter is passed by reference. This is an array because the same task can be scheduled more than once.

Output Parameters

.root:

Returns an array of data about the option in question.

Example

>D OPTSTAT^XUTMOPT("OPTION NAME",.ROOT)

Returns an array of data in ROOT (pass by ref) in the form:

    ROOT=count ROOT(1)=task number^scheduled time^reschedule freq^special queuing flag