Syntax
$RECALL |
SERVICE=GET CLASS=VARIABLE NAME='VARNAME=variable-name' |
Use
Use this API to retrieve 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)
Operands
|
Operand |
Description |
|---|---|
|
SERVICE=GET |
A value is to be retrieved. |
|
CLASS=VARIABLE |
The value to get is the value of an EventView variable. |
|
NAME='VARNAME=variable-name' |
Identifies the EventView variable. |
Returned Variables
|
Variable |
Description |
|---|---|
|
&$REVARNAME |
Contains the name of the variable. |
|
&$REVARVALUE |
Contains the value of the variable. |
|
&$REVARDESC |
Contains a description of the value of the variable. |
|
&$REVARSTATS |
Contains the date, time, and the user ID of the user who last updated the value. |
|
&SYSMSG |
Contains the message returned by $RECALL. |
Return Codes
The following return codes indicate the success or failure of command processing:
|
&RETCODE |
Meaning |
|---|---|
|
0 |
Processing was successful. |
|
8 |
Processing failed. |
|
16 |
Error occurred in call syntax. |
Example
The following example retrieves the value of TEST:
&CALL PROC=$RECALL SHARE=($RE>) + PARMS=(SERVICE=GET,+ CLASS=VARIABLE,+ NAME='VARNAME=TEST') &WRITE ZREVTEMP=&$REVARVALUE