GetAuxFlag method: Field class

Syntax

GetAuxFlag(FlagNumber)

Description

Use the GetAuxFlag method to determine whether the Auxiliary Flag Mask specified by FlagNumber has been set for a field.

Currently, only one flag comes preset from PeopleSoft: a 1 indicates a ChartField.

Parameters

Parameter	Description
FlagNumber	Specify the flag number. 1 is a ChartField. Valid values are between 1 and 16.

Returns

A Boolean value: True, the flag is set, False if the flag hasn't been set.

Example

&field = GetField(Field.RC_TEST_PB);
&ret = &field.GetAuxFlag(1);
If (&ret = True) Then
   MessageBox(0, "Metadata Fn Status", 0, 0, "Aux Flag 1 is SET - ChartField");
Else
   MessageBox(0, "Metadata Fn Status", 0, 0, "Aux Flag 1 is NOT SET - Not a Chart⇒
Field");
End-If;