DbiGetCursorForTable

C syntax

DBIResult DBIFN DbiGetCursorForTable ([hDb], pszTableName, [pszDriverType], phCursor);

Delphi syntax

function DbiGetCursorForTable (hDb: hDBIDb; pszTableName: PChar; pszDriverType: PChar; var hCursor: hDBICur): DBIResult stdcall;

Description

DbiGetCursorForTable returns an existing cursor for the given table within the current session.

Parameters

hDb Type: hDBIDb (Input)
Specifies the database handle. Optional. If supplied, DbiFormFullName is called to create a fully qualified table name.

pszTableName Type: pCHAR (Input)
Pointer to the table name.

pszDriverType Type: pCHAR (Input)
Pointer to the driver type. Optional. If supplied, used with hDb in a call to DbiFormFullName.

phCursor Type: phDBICur (Output)
Pointer to a cursor handle.

Usage

If more than one cursor is opened on the table, the first cursor found on the table is returned. There is no implied ordering of cursors on a table.

DbiResult	Meaning
DBIERR_NONE	The cursor for the table was retrieved successfully.
DBIERR_INVALIDHNDL	The specified database handle is invalid or NULL.
DBIERR_INVALIDPARAM	The specified table name or the pointer to the table name is NULL.
DBIERR_NOSUCHTABLE	The specified table name is invalid.
DBIERR_OBJNOTFOUND	A valid cursor could not be found.