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

C syntax

DBIResult DBIFN DbiGetIndexDescs (hCursor, pidxDesc);

Delphi syntax

function DbiGetIndexDescs (hCursor: hDBICur; var idxDesc: IDXDesc): DBIResult stdcall;

Description

DbiGetIndexDescs retrieves index properties for all indexes associated with this cursor.

Parameters

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

pidxDesc                Type: pIDXDesc                (Output)
Pointer to the client-allocated IDXDesc structure.

Usage

The client must allocate a buffer large enough to hold all index descriptors. The number of indexes can be obtained by using DbiGetCursorProps and examining the iIndexes property.

dBASE: DbiGetIndexDescs won't include dBASE non-production indexes if the indexes are not opened.

Oracle:                For performance reasons, bPrimary is not set in the FLDDesc structure.  To determine if a primary index exists on a table, use DbiSetProp  with the curGETEXTENDEDINFO property before calling DbiGetIndexDescs.

Prerequisites

A valid cursor handle must be obtained, and at least one index must exist.

See also

DbiGetIndexDesc, DbiOpenIndex, DbiCloseIndex, DbiGetIndexSeqNo, DbiGetCursorProps, DbiOpenIndexList, DbiGetIndexForField