Automation Services Application Program Interface › $RECALL SERVICE=SET

$RECALL SERVICE=SET

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

Syntax

This API procedure function call has the following format:

$RECALL SERVICE=SET
        CLASS=VARIABLE
        NAME=‘VARNAME=variable-name’
        PARMS=‘VALUE=new-value’
       [DESC=value-description]

Operands

This API procedure function call has the following operands:

SERVICE=SET

Specifies that a value is to be set.

CLASS=VARIABLE

Specifies that the value of an EventView variable is to be set.

NAME=‘VARNAME=variable-name’

Specifies the name of the EventView variable.

Limits: Up to eight characters long

PARMS=‘VALUE=new-value’

Specifies the new value to be set for the specified variable.

DESC=value-description

(Optional) Specifies a description for the value.

Return Variable

This API procedure function call returns the following 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: Set the Value of a Variable

This example sets the value of TEST:

&VALUE = &ZQUOTE Test’s value at &TIME
&DESC = &ZQUOTE Why Test was changed
&PARMS = &ZQUOTE VALUE=&VALUE DESC=&DESC
&CALL PROC=$RECALL +
      PARMS=(SERVICE=SET,+
             CLASS=VARIABLE,+
             NAME='VARNAME=TEST',+
             PARMS=&PARMS)