<< Click to Display Table of Contents >> Navigation:  »No topics above this level« DbiGetCallBack

C syntax

DBIResult DBIFN DbiGetCallBack (hCursor, ecbType, piClientData, piCbBufLen, ppCbBuf, ppfCb);

Delphi syntax

function DbiGetCallBack (hCursor: hDBICur; ecbType: CBType; var iClientData: Longint; var iCbBufLen: Word; var pCbBuf: Pointer; ppfCb: ppfDBICallBack): DBIResult stdcall;

Description

DbiGetCallBack returns a pointer to the function previously registered by the client (using DbiRegisterCallBack) for the given callback type.

Parameters

hCursor                Type: hDBICur                (Input)
Specifies the cursor handle. If NULL, hCursor specifies that the callback is session-wide, rather than cursor-level.

ecbType                Type: CBType                (Input)
Specifies the type of callback.

piClientData                Type: pUINT32                (Input)
Pointer to the passthrough client data (used by the client function).

piCbBufLen                Type: pUINT16                (Input)
Pointer to the callback buffer length.

ppCbBuf                Type: ppVOID                (Input)
Pointer to the callback buffer pointer.

ppfCb                Type: ppfDBICallBack                (Output)
Pointer to the client variable that receives a pointer to the callback function that was previously registered for this type. The buffer receives a NULL pointer if no function was registered.

Usage

This function is typically used to find out whether the specified callback function was registered for the given cursor handle or the currently active session.

See also

DbiRegisterCallBack