Data.Win.ADODB.TCustomADODataSet.IndexFieldNames

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property IndexFieldNames: string read GetIndexFieldNames write SetIndexFieldNames;

C++

__property System::UnicodeString IndexFieldNames = {read=GetIndexFieldNames, write=SetIndexFieldNames};

Properties

Type Visibility Source Unit Parent
property protected
Data.Win.ADODB.pas
Data.Win.ADODB.hpp
Data.Win.ADODB TCustomADODataSet

Description

Lists the columns to use for a persistent sort of the recordset.

Use IndexFieldNames as an alternative method of specifying the sort order of a recordset. IndexFieldNames is a direct implementation of the Sort property of the ADO recordset object, with the field list from IndexFieldNames being used for the Sort property. The actual sorting of data occurs on the OLE DB side and use of indexes for the sort depend on the particular provider.

To use IndexFieldNames to establish a recordset's sort order, the recordset must have been opened using a client-side cursor (the dataset component's CursorLocation property must be clUseClient). An exception is raised on attempts to use IndexFieldNames with server-side cursors.

IndexFieldNames may be used to set the sort order for the detail table in a master-detail link, increasing the performance of the link. However, use of IndexFieldNames is not required for master-detail links.

See Also