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

OPTSTAT^XUTMOPT(): Obtain Option Schedule

Reference Type: Supported, Category: TaskMan, Integration Agreement: 1472

Description

This 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 file (#19) upon which to return data.

.root:

(required) This variable 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

 


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 26, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.