peoplecodeapi

SetDBFieldNotUsed

Mon 01 January 2018

Syntax 

SetDBFieldNotUsed(Field.FieldName, NotUsed)

Description

Use the SetDBFieldNotUsed function to specify whether a database field is used as a chart field or not.

SetDBFieldNotUsed does the following for a field:

  • Specifies whether the field is included in the index when indexes are built for records that contain this field. The column always remains in the table associated with the record.

  • Specifies that the field is ignored in Query.

  • Specifies that the field is ignored in nVision.

In addition, fields marked as Search Keys or List Box Items in the Application Designer that are set as not used do not display in search dialogs and list boxes.

Parameters

Field or Control

Definition

FieldName

Specify the name of the field that you want to modify. This name must be prefixed by the reserved word Field .

NotUsed

Specify whether this field is to be used as a chart field. This parameter takes a Boolean value: True, this field is not used, False, this field is used.

Returns

A constant value. The values are:

Value

Description

%MDA_Success

Function completed successfully.

%MDA_Failure

Function didn't complete successfully.

%MDA_FieldNotFound

The specified field wasn't found.