RAD Studio VCL Reference
TDataSet.PSGetIndexDefs Method

Returns the definitions of all specified indexes defined for the dataset.

function PSGetIndexDefs(IndexTypes: TIndexOptions): TIndexDefs; virtual;
virtual __fastcall TIndexDefs PSGetIndexDefs(TIndexOptions IndexTypes);

The provider component calls PSGetIndexDefs to locate an index that contains information it needs. For example, it uses PSGetIndexDefs to locate an index that contains the key fields returned by PSGetKeyFields. This information allows the provider to locate the records that need to change when it applies updates. The provider also calls this method to locate indexes that it adds to the metadata of data packets. 

IndexTypes indicates the options required of the returned indexes. PSGetIndexDefs returns all indexes whose Options property includes the specified flags. 

PSGetIndexDefs returns a TIndexDefs object that contains all the indexes of the dataset that match the IndexTypes parameter. 


Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!