peoplecodeapi - BulkUpdateIndexes

Syntax

BulkUpdateIndexes([StringFieldArray])

Description

Use BulkUpdateIndexes to update indexes (PSINDEXDEFN table) for records that contain a field whose NotUsed setting has changed.

A field whose NotUsed flag has been set to True does not show up in indexes. The only way to modify a field's NotUsed setting is through an API call such as in the following example:

SetDBFieldNotUsed(FIELD.OrgId, True);

The indexes of records that contain this field need to be updated to reflect the new settings.

Information about this operation can be logged by turning on PeopleCode tracing of internal functions (value 256.)

Parameters

Field or Control	Definition
`StringFieldArray`	Specify an array of field names (as strings), such as DEPTID, representing the fields whose NotUsed flag has been modified. Only the records containing these fields are updated. If you do not specify a value for this parameter, the indexes for `all` records are rebuilt.

Field or Control

Definition

StringFieldArray

Specify an array of field names (as strings), such as DEPTID, representing the fields whose NotUsed flag has been modified. Only the records containing these fields are updated.

If you do not specify a value for this parameter, the indexes for all records are rebuilt.

Returns

A constant value. The values are:

Value	Description
%MDA_Success	Bulk operation completed successfully.
%MDA_Failure	Bulk operation did not complete successfully.