SetDBFieldAuxFlag
Mon 01 January 2018Syntax
SetDBFieldAuxFlag(Field.FieldName, FlagNumber, Setting)
Description
Use the SetDBFieldAuxFlag function to set the auxiliary flag mask (AuxFlagMask) property for the specified field. This field indicates properties about the field.
Currently, only one flag comes preset from PeopleSoft: a 1 indicates a ChartField. If you want to associate a property with a field, you must coordinate with other developers to make certain that no one else is setting a property using the same flag number.
Use the GetAuxFlag Field method to read the current setting of the property.
If you use this function, the change is made to the database field, but it doesn't require a rebuild of the database. However, the change is not reflected in the component buffer. You must reload the component for the new setting to take place.
Parameters
|
Field or Control |
Definition |
|---|---|
| Fieldname |
Specify the name of the field that you want the AuxMaskFlag property changed. This name must be prefixed by the reserved word Field . |
| FlagNumber |
Specify the flag value, a number between 1 and 32. A 1 is a ChartField. |
| Setting |
Specify whether this flag should be on (True) or off (False). |
Returns
A constant value. The values are:
|
Value |
Description |
|---|---|
|
%MDA_Success |
Bulk operation completed successfully. |
|
%MDA_Failure |
Bulk operation did not complete successfully. |
|
%MDA_FieldNotFound |
The specified field was not found in the database. |