DbiCloseIndex

C syntax

DBIResult DBIFN DbiCloseIndex (hCursor, pszIndexName, iIndexId);

Delphi syntax

function DbiCloseIndex (hCursor: hDBICur; pszIndexName: PChar; iIndexId: Word): DBIResult stdcall;

Description

DbiCloseIndex closes the specified index for this cursor.

Parameters

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

pszIndexName Type: pCHAR (Input)
Specifies the pointer to the index name. pszIndexName cannot be the name of the current active index of the cursor or a production index.

iIndexId Type: UINT16 (Input)
Currently not used.

Usage

DbiCloseIndex is applicable only with dBASE and FoxPro tables. It is used primarily to manipulate non-production indexes. DbiCloseIndex cannot close a current index, or a production index. To close a current index, DbiSwitchToIndex must be called first, to make another index (or no index) current.

This function does not affect the order of the records or the current position of the cursor.

Prerequisites

The index must be open.

Completion state

Once a production index is closed, it is no longer maintained.

DbiResult	Meaning
DBIERR_NONE	The index was successfully closed.
DBIERR_NA	Operation is not applicable.
DBIERR_INVALIDHNDL	The specified cursor handle is invalid or NULL.
DBIERR_CANNOTCLOSE	The given index is a production index and must stay open.
DBIERR_ACTIVEINDEX	The given index is currently used by the cursor to order the result set.
DBIERR_NOSUCHINDEX	The given index is either not opened or no such index exists for the table.