$TICALL FUNC=GET

Timer Services Interface › $TICALL FUNC=GET

$TICALL FUNC=GET

Retrieves an existing timer definition.

&CONTROL SHRVARS=($TI)
-EXEC $TICALL    FUNC=GET
               [ CLASS=classname ]
               [ SUBCLASS=subclassname ]
                 NAME=name
               [ OPT={ file get option | KEQ } ]

Retrieves an existing timer definition.

Operands:

FUNC=GET

Retrieves an existing timer definition.

CLASS=classname

Specifies a class name, maximum 8 characters. Timer definitions are categorized by class, subclass and a name. The name is mandatory but the class and subclass names are optional.

SUBCLASS=subclassname

Specifies a sub-class name, maximum 8 characters.

NAME=name

Specifies a name for this definition, maximum 12 characters. This is a required operand.

OPT = { file get option | KEQ }

Specifies the FILE GET OPTION. This option is passed to the VARTABLE GET and FILE GET verb calls. Valid values include:

KEQ (Key Equal)
KGT (Key Greater Than)
KGE (Key Greater Than or Equal)
KLT (Key Less Than)
KLE (Key Less Than or Equal)

Note: Refer to &FILE GET and &VARTABLE GET documentation for more information on these values. The default is KEQ.

Return Codes:

&RETCODE = 0

$TICALL completed successfully. Data is returned in the following variables:

$TICATCHUP: CATCHUP
$TICLASS: CLASS
$TICDATE: Create date
$TICOMMAND: COMMAND
$TIDELEXP: DELEXP
$TIEDATE: EDATE
$TIETIME: ETIME
$TIFREQ: FREQ
$TIFTYPE: FTYPE
$TIKEEP: KEEP
$TILIMIT: LIMIT
$TINAME: NAME
$TIROUTE: ROUTE
$TISDATE: SDATE
$TISTATUS: STATUS
$TISTIME: STIME
$TISUBCLASS: SUBCLASS
$TIUSER: Create/modify user ID
$TIAUTH: User authority of $TIUSER
$TIMDATE: Modified date
$TIMTIME: Modified time

&RETCODE > 0

An error occurred. &SYSMSG is set with an error message.

Examples FUNC=GET

&CALL PROC=$TICALL SHARE=($TI>) PARMS=(FUNC=GET CLASS=USER +
 NAME=CMD1)
* Timer &$TICLASS/&$TISUBCLASS/&$TINAME data returned