DbiGetFieldDescs

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiGetFieldDescs

Return to chapter overview

C syntax

DBIResult DBIFN DbiGetFieldDescs (hCursor, pfldDesc);

Delphi syntax

function DbiGetFieldDescs (hCursor: hDBICur; pfldDesc: pFLDDesc): DBIResult stdcall;

Description

DbiGetFieldDescs retrieves a list of descriptors for all the fields in the table associated with hCursor. The structure returned is identical in form to the fields contained in DbiOpenFieldList.

Parameters

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

pfldDesc                Type: pFLDDesc                (Output)
Pointer to the client FLDDesc structures, one for each of the fields in the table associated with the specified cursor.

Usage

The field descriptors returned are in accordance with the translation mode set for the cursor. If the translation mode is xltNONE, the physical field descriptors are returned. If the translation mode is xltFIELD, the logical field descriptors are returned.

Use DbiGetCursorProps to get the number of field in the table.

DbiResult

Meaning

DBIERR_NONE

The field Descriptions were returned successfully.

DBIERR_INVALIDHNDL

The specified cursor handle is invalid or NULL.

See also

DbiGetCursorProps, DbiOpenFieldList.