<< Click to Display Table of Contents >> Navigation:  »No topics above this level« DbiGetIndexSeqNo

C syntax

DBIResult DBIFN DbiGetIndexSeqNo (hCursor, pszIndexName, pszTagName, iIndexId, piIndexSeqNo);

Delphi syntax

function DbiGetIndexSeqNo (hCursor: hDBICur; pszIndexName: PChar; pszTagName: PChar; iIndexId: Word; var iIndexSeqNo: Word): DBIResult stdcall;

Description

DbiGetIndexSeqNo retrieves the ordinal number of the index in the index list of the specified cursor.

Parameters

hCursor                Type: hDBICur                (Input)
Specifies the cursor handle.

pszIndexName                Type: pCHAR                (Input)
Pointer to the index name.

pszTagName                Type: pCHAR                (Input)
For dBASE and FoxPro only. Pointer to the index tag name.

iIndexId                Type: UINT16                (Input)
Specifies the index ID, if required to identify an index.

piIndexSeqNo                Type: pUINT16                (Output)
Pointer to the client variable which receives the index sequence number.

Usage

dBASE or FoxPro: For dBASE or FoxPro tables, the ordinal number of the index in the index list can be affected by the opening and closing of indexes on the cursor. pszIndexName and pszTagName are used to specify the index.

Paradox, Access: The index can be specified by name or ID.

SQL: The index must be specified by name.

Completion state

The sequence number of the specified index is returned. The result of this function can be used as input for DbiGetIndexDesc.

See also

DbiGetIndexDesc