Verbs and Built-in Functions › &AOMGVAR

&AOMGVAR

&AOMGVAR alters or inspects the value of an AOM global variable.

&AOMGVAR is used as a verb using the following format:

&AOMGVARn [ value ]

When used as a built-in function, &AOMGVAR must be coded to the right of an assignment statement:

&variable =&AOMGVARn

Used as a verb, &AOMGVAR is coded within an AOMPROC procedure to alter the value of an AOM global variable. These global variables are visible to the screening table and is tested and altered by screening table statements.

Used as a built-in function, any NCL procedure can inspect the value of an AOM global variable.

Operands:

n

Specifies the number of the global variable to alter or inspect. n must be from 1 to 16.

value

Specifies the new value of the indicated global variable. value is null, which will set the global variable to all blanks. Otherwise, the value must be from 1 to 16 characters. The value will be stored in the indicated global variable, padded with blanks if necessary. The interpretation of AOM global variables is entirely dependent on the user.

Examples: &AOMGVAR

&AOMGVAR 3 CHICAGO  -* set global variable 3 to 'CHICAGO'

&AOMGVAR 15 START   -* set global variable 15 to 'START'

&VAR4 = &AOMGVAR 4  -* get current value of global
                    -* variable 4

Notes:

• Screening table statements can test the value of an AOM global variable using the GVAR(n) screening criteria, or alter the value of a global variable using SET GVAR(n) = value. The values can also be used in screening table substitution, by using the &GVARn variable names.
• If used as a verb, by a procedure that is not an AOMPROC, the procedure is terminated with an error message.