OCILIB (C and C++ Driver for Oracle)
4.7.5
Open source and cross platform Oracle Driver delivering efficient access to Oracle databases.
|
OcilibCApiInitialization
OCILIB provides two mechanisms for error handling:
Exceptions are raised:
If an error handler was provided to OCI_Initialize(), when an error occurs, the library generates an OCI_Error handle and pass it to the error handler.
In order to use the thread contextual error handling, you must call OCI_Initialize() with the flag OCI_ENV_CONTEXT for the mode parameter. When activated, error handles are stored per thread and the last error within a thread can be retrieved with OCI_GetLastError()
Exception properties are accessible through a set of functions
Oracle warnings are raised through OCI_Error API. Such error handles have their error type property (OCI_ErrorGetType()) set to OCI_ERR_WARNING. Warning handing is disabled by default. To activate/deactivate it, use OCI_EnableWarnings()
Functions | |
OCI_SYM_PUBLIC boolean OCI_API | OCI_SetErrorHandler (POCI_ERROR handler) |
Set the global error user handler. | |
OCI_SYM_PUBLIC OCI_Error *OCI_API | OCI_GetLastError (void) |
Retrieve the last error or warning occurred within the last OCILIB call. | |
OCI_SYM_PUBLIC const otext *OCI_API | OCI_ErrorGetString (OCI_Error *err) |
Retrieve error message from error handle. | |
OCI_SYM_PUBLIC unsigned int OCI_API | OCI_ErrorGetType (OCI_Error *err) |
Retrieve the type of error from error handle. | |
OCI_SYM_PUBLIC int OCI_API | OCI_ErrorGetOCICode (OCI_Error *err) |
Retrieve Oracle Error code from error handle. | |
OCI_SYM_PUBLIC int OCI_API | OCI_ErrorGetInternalCode (OCI_Error *err) |
Retrieve Internal Error code from error handle. | |
OCI_SYM_PUBLIC OCI_Connection *OCI_API | OCI_ErrorGetConnection (OCI_Error *err) |
Retrieve connection handle within the error occurred. | |
OCI_SYM_PUBLIC OCI_Statement *OCI_API | OCI_ErrorGetStatement (OCI_Error *err) |
Retrieve statement handle within the error occurred. | |
OCI_SYM_PUBLIC unsigned int OCI_API | OCI_ErrorGetRow (OCI_Error *err) |
Return the row index which caused an error during statement execution. | |
OCI_SYM_PUBLIC const otext *OCI_API | OCI_ErrorGetLocation (OCI_Error *err) |
Return the location where the error occured. | |
OCI_SYM_PUBLIC boolean OCI_API OCI_SetErrorHandler | ( | POCI_ERROR | handler | ) |
#include <api.h>
Set the global error user handler.
handler | - Pointer to error handler procedure |
OCI_SYM_PUBLIC OCI_Error *OCI_API OCI_GetLastError | ( | void | ) |
#include <api.h>
Retrieve the last error or warning occurred within the last OCILIB call.
Referenced by ocilib::core::Check().
OCI_SYM_PUBLIC const otext *OCI_API OCI_ErrorGetString | ( | OCI_Error * | err | ) |
#include <api.h>
Retrieve error message from error handle.
err | - Error handle |
OCI_SYM_PUBLIC unsigned int OCI_API OCI_ErrorGetType | ( | OCI_Error * | err | ) |
#include <api.h>
Retrieve the type of error from error handle.
err | - Error handle |
OCI_SYM_PUBLIC int OCI_API OCI_ErrorGetOCICode | ( | OCI_Error * | err | ) |
#include <api.h>
Retrieve Oracle Error code from error handle.
err | - Error handle |
OCI_SYM_PUBLIC int OCI_API OCI_ErrorGetInternalCode | ( | OCI_Error * | err | ) |
#include <api.h>
Retrieve Internal Error code from error handle.
err | - Error handle |
OCI_SYM_PUBLIC OCI_Connection *OCI_API OCI_ErrorGetConnection | ( | OCI_Error * | err | ) |
#include <api.h>
Retrieve connection handle within the error occurred.
err | - Error handle |
OCI_SYM_PUBLIC OCI_Statement *OCI_API OCI_ErrorGetStatement | ( | OCI_Error * | err | ) |
#include <api.h>
Retrieve statement handle within the error occurred.
err | - Error handle |
OCI_SYM_PUBLIC unsigned int OCI_API OCI_ErrorGetRow | ( | OCI_Error * | err | ) |
#include <api.h>
Return the row index which caused an error during statement execution.
err | - Error handle |
OCI_SYM_PUBLIC const otext *OCI_API OCI_ErrorGetLocation | ( | OCI_Error * | err | ) |
#include <api.h>
Return the location where the error occured.
err | - Error handle |