Sign in Join
FPDoc Onlineexperiment

TCustomBufDataset.InternalAddIndex function

Member of TCustomBufDatasetprotectedIn unit BufDataset

Performs actions needed to add an index to the dataset.

Declaration

pascal
function InternalAddIndex(const AName: string; const AFields: string; 
 AOptions: TIndexOptions; 
 const ADescFields: string; 
 const ACaseInsFields: string)
: TBufDatasetIndex; virtual

Arguments

AName

Name for the index.

AFields

Fields included in the index.

AOptions

Options for the index.

ADescFields

Descending fields in the index.

ACaseInsFields

Case-insensitive fields in the index.

Function result

Index added to the dataset.

Description

InternalAddIndex is a TBufDatasetIndex function used to perform actions needed to add an index to the dataset. InternalAddIndex adds a TBufDatasetIndex instance to the internal member used for indexes defined in the dataset. Arguments passed to the method are assigned to the corresponding properties in the TBufDatasetIndex instance.

InternalAddIndex calls the InternalCreateIndex method using the return value as an argument.

InternalAddIndex is used in the implementation of the AddIndex and InitDefaultIndexes methods.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.