OCIUserCallbackGet()

Purpose

Determines the callback that is registered for a handle.

Syntax

sword OCIUserCallbackGet ( dvoid   *hndlp,
                           ub4   type,
                           dvoid   *ehndlp,
                           ub4   fcode,
                           ub4   when
                           OCIUserCallback (*callbackp)
                                           (/*_ 
                                             dvoid  *ctxp,
                                             dvoid  *hndlp,
                                             ub4  type,
                                             ub4  fcode,
                                             ub1  when,
                                             sword  returnCode,
                                             ub4  *errnop,
                                             va_list arglist
                                            _*/),
                           dvoid   **ctxpp 
                           OCIUcb  *ucbDesc );

Parameters

hndlp (IN)

This is the handle whose type is specified by the type parameter.

type (IN)

The handle type. The valid handle type is:

• OCI_HTYPE_ENV - The callback is registered for all calls of the function specified by fcode made on the environment handle.

ehndlp (IN)

The OCI error or environment handle. If there is an error, it is recorded in ehndlp and this function returns OCI_ERROR. Diagnostic information can be obtained by calling OCIErrorGet().

fcode (IN)

A unique function code of an OCI function. These are listed in Table 16-8, "OCI Function Codes".

when (IN)

Defines when the callback is invoked. Valid modes are:

• OCI_CBTYPE_ENTRY - the callback is invoked on entry into the OCI function.
• OCI_CBTYPE_EXIT - the callback is invoked before exit from the OCI function.
• OCI_UCBTYPE_REPLACE - if it returns anything other than an OCI_CONTINUE, then the next replacement callback and the OCI code for the OCI function is not called. Instead, processing jumps to the exit callbacks. For information about this parameter see OCIUserCallbackRegister().

callbackp (OUT)

A pointer to a callback function pointer. This returns the function that is currently registered for these values of fcode, when, and hndlp. The value returned would be NULL if no callback is registered for this case.

ctxpp (OUT)

A pointer to return context for the currently registered callback.

ucbDesc (IN)

An OCI provided descriptor. This descriptor is passed by OCI in the environment callback. It contains the priority at which the callback would be registered at. If the ucbDesc parameter is specified as NULL, then this callback has the highest priority.

User callbacks registered statically (as opposed to those registered dynamically in a package) use a null descriptor because they do not have a ucb descriptor to use.

Comments

This function finds out what callback is registered for a particular handle.

Related Functions

OCIUserCallbackRegister()