Datasnap.DBClient.TCustomClientDataSet.GetIndexInfo

• Up to Parent: TCustomClientDataSet

Delphi

procedure GetIndexInfo(IndexName: string);

C++

void __fastcall GetIndexInfo(System::UnicodeString IndexName);

Properties

Type	Visibility	Source	Unit	Parent
procedure function	public	Datasnap.DBClient.pas Datasnap.DBClient.hpp	Datasnap.DBClient	TCustomClientDataSet

Description

Retrieves information about the current index.

Call GetIndexInfo to populate a dataset's internal index fields with information about the current index, including its field count, map, and key size.

Pass the name of the current index as the IndexName to retrieve the default grouping level of the index as well. If an empty string is supplied for IndexName, no grouping level information is retrieved.

Warning: Do not pass GetIndexInfo the name of any index other than the current index.

See Also

• Data.DB.TDataSet.FieldCount

• IndexDefs

• KeySize

• GetIndexNames

• Data.DB.TIndexDef.GroupingLevel