DbiGetCursorProps

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiGetCursorProps

Return to chapter overview

C syntax

DBIResult DBIFN DbiGetCursorProps (hCursor, pcurProps);

Delphi syntax

function DbiGetCursorProps (hCursor: hDBICur; var curProps: CURProps): DBIResult stdcall;

Description

DbiGetCursorProps returns the properties of the cursor.

Parameters

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

pcurProps                Type: pCURProps                (Output)
Pointer to the client-allocated CURProps structure.

Usage

This function retrieves the most commonly used cursor properties. Additional properties can be obtained by using DbiGetProp. This function can be called immediately after DbiOpenTable to retrieve information necessary to allocate the record buffer and the array for the field descriptors in the table.

FoxPro: To see if a cursor is referencing a FoxPro table, check if iTblLevel is equal to the constant FOXLEVEL25.

DbiResult

Meaning

DBIERR_NONE

Cursor properties for hCursor were successfully retrieved.

DBIERR_INVALIDHNDL

The specified cursor handle is invalid or NULL.

See also

DbiGetProp, DbiSetProp, Getting and Setting Properties, CURProps