Bde.DBTables.TBDEDataSet.GetIndexInfo

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure GetIndexInfo;

C++

void __fastcall GetIndexInfo();

Properties

Type Visibility Source Unit Parent
procedure
function
public
Bde.DBTables.pas
Bde.DBTables.hpp
Bde.DBTables TBDEDataSet

Description

Retrieves information about the current index into the index data fields of the dataset.

Call GetIndexInfo to update information about the current index. Ordinarily an application does not need to call GetIndexInfo because this routine is used internally to retrieve index information as needed. Some applications, however, may want to ensure that the index information used by the dataset is up-to-date.

GetIndexInfo queries the BDE for index information, including:

Whether the current index is a dBASE expression index.

Whether the index is case insensitive.

The number of fields that make up the key for the index.

The field map for the index.

The size of the index key.

Number of fields and field map are not retrieved if the index is a dBASE expression index.

See Also