XUTMOPT Option scheduling interface ICR (1472)

Name

Value

NUMBER

1472

IA #

1472

DATE CREATED

1996/01/23

CUSTODIAL PACKAGE

KERNEL

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XUTMOPT

NAME

XUTMOPT Option scheduling interface

GENERAL DESCRIPTION

This routine holds several supported calls for access
to the option scheduling file.

STATUS

Active

DURATION

Till Otherwise Agreed

XUTMOPT

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

EDIT

This entry point allows users to edit an option's
scheduling in the OPTION SCHEDULING file (#19.2).

Usage  D EDIT^XUTMOPT(option_name)

VARIABLES	TYPE	VARIABLES DESCRIPTION
option_name	Input	The name of the option from the option file that the user is to be allowed to edit.

DISP

This entry point is used to display the schedule for
an option.

Usage  D DISP^XUTMOPT(option_name)

VARIABLES	TYPE	VARIABLES DESCRIPTION
option_name	Input	The name of the option from the option file that the taskman schedule is to be displayed.

RESCH

This entry point allows an application to set-up the
schedule for an option.

Usage  D RESCH^XUTMOPT(option_name,when_to_run,device_to_use,
re-schedule_freq,flags,error_array)

VARIABLES	TYPE	VARIABLES DESCRIPTION
option_name	Input	Name of the option to be rescheduled.
when_to_run	Input	(optional) The new scheduled time for the option to run.
device_to_use	Input	(optional) The device to use for the rescheduled option.
re-schedule_freq	Input	(optional) The frequency to run the rescheduled option.
flags	Input	(optional) If the flag is set to an 'L' LAYGO a new entry if needed.
error_array	Both	(optional) Pass by reference. Will be set to -1 if the option was not found.

OPTSTAT

This entry point allows an application to find out
when a option is scheduled and get other data.

VARIABLES

TYPE

VARIABLES DESCRIPTION

optionname

Input

This is the name of the OPTION (.01 field of file 19)
to return data on.

ROOT

Both

This variable is passed by reference and 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 queueing flag This is an array because the same task can be
scheduled more that once.