Using OCI Handles directly

Detailed Description

OcilibCApiInstancesManagement

OCILIB conception was focused on a full but closed encapsulation of OCI.

All OCI headers, data types, prototypes are imported internally (linkage or runtime import).

OCILIB public interface exposes only ISO C scalar types and OCILIB objects.

OCI is a wide and rich API that can deal with hundreds of options.

OCILIB tries to implement most of it. But, sometimes in really specific contexts, it might be necessary to directly call OCI APIs in order to use uncovered OCI functionalities or options.

OCILIB proposes a set of functions to retrieve its internal OCI handles.

Warning

The OCILIB author strongly advises against the use of internal handles, unless there is no other way to accomplish the task.

Warning

Using these handles for direct application calls to OCI might lead to OCILIB instability or crash if handles are incorrectly used.

Functions
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetEnvironment (void)
	Return the OCI Environment Handle (OCIEnv *) of OCILIB library.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetContext (OCI_Connection *con)
	Return the OCI Context Handle (OCISvcCtx *) of an OCILIB OCI_Connection object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetServer (OCI_Connection *con)
	Return the OCI Server Handle (OCIServer *) of an OCILIB OCI_Connection object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetError (OCI_Connection *con)
	Return the OCI Error Handle (OCIError *) of an OCILIB OCI_Connection object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetSession (OCI_Connection *con)
	Return the OCI Session Handle (OCISession *) of an OCILIB OCI_Connection object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetTransaction (OCI_Transaction *trans)
	Return the OCI Transaction Handle (OCITrans *) of an OCILIB OCI_Transaction object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetStatement (OCI_Statement *stmt)
	Return the OCI Statement Handle (OCIStmt *) of an OCILIB OCI_Statement object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetLob (OCI_Lob *lob)
	Return the OCI LobLocator Handle (OCILobLocator *) of an OCILIB OCI_Lob object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetFile (OCI_File *file)
	Return the OCI LobLocator Handle (OCILobLocator *) of an OCILIB OCI_File object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetDate (OCI_Date *date)
	Return the OCI Date Handle (OCIDate *) of an OCILIB OCI_Date object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetTimestamp (OCI_Timestamp *tmsp)
	Return the OCI Datetime Handle (OCIDatetime *) of an OCILIB OCI_Timestamp object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetInterval (OCI_Interval *itv)
	Return the OCI Interval Handle (OCIInterval *) of an OCILIB OCI_Interval object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetObject (OCI_Object *obj)
	Return the OCI Object Handle (void *) of an OCILIB OCI_Object object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetColl (OCI_Coll *coll)
	Return the OCI Collection Handle (OCIColl *) of an OCILIB OCI_Coll object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetRef (OCI_Ref *ref)
	Return the OCI Ref Handle (OCIRef *) of an OCILIB OCI_Ref object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetMutex (OCI_Mutex *mutex)
	Return the OCI Mutex handle (OCIThreadMutex *) of an OCILIB OCI_Mutex object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetThreadID (OCI_Thread *thread)
	Return the OCI Thread ID (OCIThreadId *) of an OCILIB OCI_Thread object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetThread (OCI_Thread *thread)
	Return the OCI Thread handle (OCIThreadHandle *) of an OCILIB OCI_Thread object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetDirPathCtx (OCI_DirPath *dp)
	Return the OCI DirectPath Context handle (OCIDirPathCtx *) of an OCILIB OCI_DirPath object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetDirPathColArray (OCI_DirPath *dp)
	Return the OCI DirectPath Column array handle (OCIDirPathColArray *) of an OCILIB OCI_DirPath object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetDirPathStream (OCI_DirPath *dp)
	Return the OCI DirectPath Stream handle (OCIDirPathStream *) of an OCILIB OCI_DirPath object.
OCI_SYM_PUBLIC const void *OCI_API	OCI_HandleGetSubscription (OCI_Subscription *sub)
	Return the OCI Subscription handle (OCISubscription *) of an OCILIB OCI_Subscription object.

Function Documentation

OCI_HandleGetEnvironment()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetEnvironment

(

void

)

#include <api.h>

Return the OCI Environment Handle (OCIEnv *) of OCILIB library.

Returns

The OCI Environment handle, or NULL on failure.

OCI_HandleGetContext()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetContext

(

OCI_Connection *

con

)

#include <api.h>

Return the OCI Context Handle (OCISvcCtx *) of an OCILIB OCI_Connection object.

Parameters

con	- Connection handle

Returns

The OCI Context handle, or NULL on failure.

OCI_HandleGetServer()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetServer

(

OCI_Connection *

con

)

#include <api.h>

Return the OCI Server Handle (OCIServer *) of an OCILIB OCI_Connection object.

Parameters

con	- Connection handle

Returns

The OCI Server handle, or NULL on failure.

OCI_HandleGetError()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetError

(

OCI_Connection *

con

)

#include <api.h>

Return the OCI Error Handle (OCIError *) of an OCILIB OCI_Connection object.

Parameters

con	- Connection handle

Returns

The OCI Error handle, or NULL on failure.

OCI_HandleGetSession()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetSession

(

OCI_Connection *

con

)

#include <api.h>

Return the OCI Session Handle (OCISession *) of an OCILIB OCI_Connection object.

Parameters

con	- Connection handle

Returns

The OCI Session handle, or NULL on failure.

OCI_HandleGetTransaction()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetTransaction

(

OCI_Transaction *

trans

)

#include <api.h>

Return the OCI Transaction Handle (OCITrans *) of an OCILIB OCI_Transaction object.

Parameters

trans

- Transaction handle

Returns

The OCI Transaction handle, or NULL on failure.

OCI_HandleGetStatement()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetStatement

(

OCI_Statement *

stmt

)

#include <api.h>

Return the OCI Statement Handle (OCIStmt *) of an OCILIB OCI_Statement object.

Parameters

stmt	- Statement handle

Returns

The OCI Statement handle, or NULL on failure.

OCI_HandleGetLob()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetLob

(

OCI_Lob *

lob

)

#include <api.h>

Return the OCI LobLocator Handle (OCILobLocator *) of an OCILIB OCI_Lob object.

Parameters

lob	- Lob handle

Returns

The OCI LobLocator handle, or NULL on failure.

OCI_HandleGetFile()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetFile

(

OCI_File *

file

)

#include <api.h>

Return the OCI LobLocator Handle (OCILobLocator *) of an OCILIB OCI_File object.

Parameters

file	- File handle

Returns

The OCI LobLocator handle, or NULL on failure.

OCI_HandleGetDate()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetDate

(

OCI_Date *

date

)

#include <api.h>

Return the OCI Date Handle (OCIDate *) of an OCILIB OCI_Date object.

Parameters

date	- Date handle

Returns

The OCI Date handle, or NULL on failure.

OCI_HandleGetTimestamp()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetTimestamp

(

OCI_Timestamp *

tmsp

)

#include <api.h>

Return the OCI Datetime Handle (OCIDatetime *) of an OCILIB OCI_Timestamp object.

Parameters

tmsp	- Timestamp handle

Returns

The OCI Datetime handle, or NULL on failure.

OCI_HandleGetInterval()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetInterval

(

OCI_Interval *

itv

)

#include <api.h>

Return the OCI Interval Handle (OCIInterval *) of an OCILIB OCI_Interval object.

Parameters

itv	- Interval handle

Returns

The OCI Interval handle, or NULL on failure.

OCI_HandleGetObject()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetObject

(

OCI_Object *

obj

)

#include <api.h>

Return the OCI Object Handle (void *) of an OCILIB OCI_Object object.

Parameters

obj	- Object handle

Returns

The OCI Object handle, or NULL on failure.

OCI_HandleGetColl()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetColl

(

OCI_Coll *

coll

)

#include <api.h>

Return the OCI Collection Handle (OCIColl *) of an OCILIB OCI_Coll object.

Parameters

coll	- Collection handle

Returns

The OCI Collection handle, or NULL on failure.

OCI_HandleGetRef()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetRef

(

OCI_Ref *

ref

)

#include <api.h>

Return the OCI Ref Handle (OCIRef *) of an OCILIB OCI_Ref object.

Parameters

ref	- Ref handle

Returns

The OCI Ref handle, or NULL on failure.

OCI_HandleGetMutex()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetMutex

(

OCI_Mutex *

mutex

)

#include <api.h>

Return the OCI Mutex handle (OCIThreadMutex *) of an OCILIB OCI_Mutex object.

Parameters

mutex

- Mutex handle

Returns

The OCI Mutex handle, or NULL on failure.

OCI_HandleGetThreadID()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetThreadID

(

OCI_Thread *

thread

)

#include <api.h>

Return the OCI Thread ID (OCIThreadId *) of an OCILIB OCI_Thread object.

Parameters

thread

- Thread handle

Returns

The OCI Thread ID, or NULL on failure.

Referenced by ocilib::Thread::GetThreadId().

OCI_HandleGetThread()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetThread

(

OCI_Thread *

thread

)

#include <api.h>

Return the OCI Thread handle (OCIThreadHandle *) of an OCILIB OCI_Thread object.

Parameters

thread

- Thread handle

Returns

The OCI Thread handle, or NULL on failure.

OCI_HandleGetDirPathCtx()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetDirPathCtx

(

OCI_DirPath *

dp

)

#include <api.h>

Return the OCI DirectPath Context handle (OCIDirPathCtx *) of an OCILIB OCI_DirPath object.

Parameters

dp	- DirectPath handle

Returns

The OCI DirectPath Context handle, or NULL on failure.

OCI_HandleGetDirPathColArray()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetDirPathColArray

(

OCI_DirPath *

dp

)

#include <api.h>

Return the OCI DirectPath Column array handle (OCIDirPathColArray *) of an OCILIB OCI_DirPath object.

Parameters

dp	- DirectPath handle

Returns

The OCI DirectPath Column array handle, or NULL on failure.

OCI_HandleGetDirPathStream()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetDirPathStream

(

OCI_DirPath *

dp

)

#include <api.h>

Return the OCI DirectPath Stream handle (OCIDirPathStream *) of an OCILIB OCI_DirPath object.

Parameters

dp	- DirectPath handle

Returns

The OCI DirectPath Stream handle, or NULL on failure.

OCI_HandleGetSubscription()

OCI_SYM_PUBLIC const void *OCI_API OCI_HandleGetSubscription

(

OCI_Subscription *

sub

)

#include <api.h>

Return the OCI Subscription handle (OCISubscription *) of an OCILIB OCI_Subscription object.

Parameters

sub	- Subscription handle

Returns

The OCI Subscription handle, or NULL on failure.