Verbs and Built-in Functions › &AOMGFLAG

&AOMGFLAG

&AOMGFLAG alters or inspects the value of an AOM global flag.

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

&AOMGFLAGn { ON | OFF }

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

&variable =&AOMGFLAGn

Used as a verb, &AOMGFLAG is coded within an AOMPROC procedure to alter the value of an AOM global flag. These global flags 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 flag.

Operands:

n

Specifies the number of the global flag to alter or inspect. n must be from 1 to 32.

ON | OFF

Specifies the new value of the indicated global flag.

ON sets the flag on, and OFF sets it off. The interpretation of these settings is entirely dependent on the user.

Examples: &AOMGFLAG

&AOMGFLAG 5 ON       -* set global flag 5 on

&AOMGFLAG 32 OFF     -* set global flag 32 off

&FLAG7 = &AOMGFLAG 7 -* inspect the current value of
                     -* global flag 7

Notes:

• Screening table statements can test the value of an AOM global flag using the GFLAG(n) screening criteria, or alter the value of the first 16 global flags using SET GFLAG(n) = ON | OFF.
• If used as a verb in a procedure that is not an AOMPROC, the procedure is terminated with an error message.