DbiGetLdObj

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiGetLdObj

Return to chapter overview

C syntax

DBIResult DBIFN DbiGetLdObj (hCursor,*ppLdObj);

Delphi syntax

function DbiGetLdObj (hCursor: hDBICur; var pLdObj: Pointer): DBIResult stdcall;

Description

DbiGetLdObj returns the language driver object associated with the given cursor.

Parameters

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

*ppLdObj                Type: pVOID                (Output)
Pointer to the client variable that receives the pointer to the language driver.

Usage

The object pointer returned in this function can be used with DbiNativeToAnsi and DbiAnsiToNative.

Completion state

If a valid cursor is passed to this function, the returned object pointer has a lifetime equivalent to the cursor's lifetime. In other words, if the cursor is closed (and no other cursors are open on the same table), the language driver object is destroyed and can no longer be accessed through this object pointer.

If the hCursor parameter is NULL, a pointer to the system language driver is returned. This pointer is valid for the duration of the session and can be used regardless of which cursors are opened or closed.

DbiResult

Meaning

DBIERR_NONE

The language driver object was returned successfully.

See also

DbiNativeToAnsi, DbiAnsiToNative