DbiOpenIndexTypesList

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiOpenIndexTypesList

Return to chapter overview

C syntax

DBIResult DBIFN DbiOpenIndexTypesList (pszDriverType, phCur);

Delphi syntax

function DbiOpenIndexTypesList (pszDriverType: PChar; var hCur: hDBICur): DBIResult stdcall;

Description

DbiOpenIndexTypesList creates a table containing a list of all supported index types for the driver type.

Parameters

pszDriverType                Type: pCHAR                (Input)
Pointer to the driver type.

phCur                Type: phDBICur                (Output)
Pointer to the cursor handle.

Completion state

Each of the index type description records can be retrieved using DbiGetNextRecord. DbiGetCursorProps can be used to allocate the proper record size. After the record is retrieved, it can be cast with the IDXType type definition, and used like an IDXType C language structure.

DbiResult

Meaning

DBIERR_NONE

The list of all supported index types was returned successfully.

DBIERR_UNKNOWNTBLTYPE

The specified driver type is unknown.

DBIERR_INVALIDHNDL

The specified handle is invalid.

See also

DbiGetIndexDesc