Automation Services Application Program Interface › $RECALL SERVICE=GET

$RECALL SERVICE=GET

This API procedure function call retrieves the value of an EventView variable.

If you make this call from an NCL procedure, ensure that you share the &$REVAR-prefixed variables, for example, by adding the following statement before the call:

&CONTROL SHRVARS=($REVAR)

Syntax

This API procedure function call has the following format:

$RECALL SERVICE=GET
        CLASS=VARIABLE
        NAME=‘VARNAME=variable-name’

Operands

This API procedure function call has the following operands:

SERVICE=GET

Specifies that a value is to be retrieved.

CLASS=VARIABLE

Specifies that the value to get is the value of an EventView variable.

NAME=‘VARNAME=variable-name’

Specifies the name of the EventView variable.

Limits: Up to eight characters long

Return Variables

This API procedure function call returns the following variables:

&$REVARDESC

Contains a description of the value of the EventView variable.

&$REVARNAME

Contains the name of the EventView variable.

&$REVARSTATS

Contains the date, time, and the user ID of the user who last updated the value.

&$REVARVALUE

Contains the value of the EventView variable.

&SYSMSG

Contains the returned message.

Return Codes

Return codes indicate the success or failure of processing. This API procedure function call returns the following return codes in the &RETCODE variable:

0

Indicates that processing was successful.

8

Indicates that processing failed.

16

Indicates that error occurred in the call syntax.

Example: Retrieve the Value of a Variable

The following example retrieves the value of TEST:

&CALL PROC=$RECALL SHARE=($RE>) +
      PARMS=(SERVICE=GET,+
             CLASS=VARIABLE,+
             NAME='VARNAME=TEST')
&WRITE ZREVTEMP=&$REVARVALUE