Datasnap.DBClient.TCustomClientDataSet.IndexName

• Up to Parent: TCustomClientDataSet

[–] Properties Type: property Visibility: protected Source:

Datasnap.DBClient.pas

Datasnap.DBClient.hpp

Unit: Datasnap.DBClient Parent: TCustomClientDataSet

Delphi

property IndexName: string read GetIndexName write SetIndexName;

C++

__property System::UnicodeString IndexName = {read=GetIndexName, write=SetIndexName};

Description

Identifies an index for the client dataset.

Use IndexName to specify an alternative index for a client dataset. If IndexName is empty, the dataset's sort order is based on the IndexFieldNames property or on its default ordering in the data packet. Default ordering is determined by the predefined index, DEFAULT_ORDER.

If IndexName contains a valid index name, then that index is used to determine sort order of records.

Note: IndexFieldNames and IndexName are mutually exclusive. Setting one clears the other.

See Also

• IndexFieldNames

• Deleting and Switching Indexes

Code Examples

• IndexName (C++)
• IndexName (Delphi)