Bde.DBTables.TTable.IndexName

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: property
Visibility: published
Source:
Bde.DBTables.pas
Bde.DBTables.hpp
Unit: Bde.DBTables
Parent: TTable

Delphi

property IndexName: string read GetIndexName write SetIndexName;

C++

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

Description

Identifies a secondary index for the table.

Use IndexName to specify an alternative index for a table. If IndexName is empty, a table sort order is based on its default index, or, for dBASE tables, on its physical record order.

If IndexName contains a valid index name, then that index determines the sort order of records. For dBASE tables, an index name supplied to the IndexName property must either reside in the master index file of the table, or in another index file already specified in the IndexFiles property.

Note: IndexFieldNames and IndexName are mutually exclusive. Setting one clears the other. For Paradox tables, if only one field is indexed and there are no options, the IndexName property must equal the field name (or BDE error #10022 (2726) 'Invalid index/tag name.' results). If you add an option, such as ixCaseInsensitive, IndexName can be an arbitrary name.

See Also