API:Datasnap.DBClient.TClientDataSet.IndexName

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: property
Visibility: published
Source:
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Unit: Datasnap.DBClient
Parent: TClientDataSet

Delphi

property IndexName;

C++

__property IndexName = {default=0};

Description

Identifies an index for the client dataset.

Datasnap.DBClient.TClientDataSet.IndexName inherits from Datasnap.DBClient.TCustomClientDataSet.IndexName. All content below this line refers to Datasnap.DBClient.TCustomClientDataSet.IndexName.

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

Code Examples