From RAD Studio API Documentation
Jump to: navigation, search


function PSGetIndexDefs(IndexTypes: TIndexOptions = [ixPrimary..ixNonMaintained]): TIndexDefs;


virtual TIndexDefs* __fastcall PSGetIndexDefs _DEPRECATED_ATTRIBUTE0 (TIndexOptions IndexTypes = (TIndexOptions() << TIndexOption::ixPrimary << TIndexOption::ixUnique << TIndexOption::ixDescending << TIndexOption::ixCaseInsensitive << TIndexOption::ixExpression << TIndexOption::ixNonMaintained )) = 0 ;


Type Visibility Source Unit Parent
function public
Data.DB IProviderSupport


Warning: PSGetIndexDefs is deprecated. Please use IProviderSupportNG.

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

The provider component calls PSGetIndexDefs to locate an index that contains the needed information. 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.

See Also