Functions

Using OCI Handles directly


Detailed Description

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

All OCI headers, datatypes, 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 deals with hundreds of options !

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

Function Documentation

OCI_EXPORT const void* OCI_API OCI_HandleGetEnvironment ( void   ) 

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

Returns:
OCI Environment handle otherwise NULL

Definition at line 46 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetContext ( OCI_Connection con  ) 

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

Parameters:
con - Connection handle
Returns:
OCI Context handle otherwise NULL

Definition at line 58 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetServer ( OCI_Connection con  ) 

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

Parameters:
con - Connection handle
Returns:
OCI Server handle otherwise NULL

Definition at line 74 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetError ( OCI_Connection con  ) 

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

Parameters:
con - Connection handle
Returns:
OCI Error handle otherwise NULL

Definition at line 90 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetSession ( OCI_Connection con  ) 

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

Parameters:
con - Connection handle
Returns:
OCI Session handle otherwise NULL

Definition at line 106 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetTransaction ( OCI_Transaction trans  ) 

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

Parameters:
trans - Trasanction handle
Returns:
OCI Trasanction handle otherwise NULL

Definition at line 122 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetStatement ( OCI_Statement stmt  ) 

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

Parameters:
stmt - Statement handle
Returns:
OCI Statement handle otherwise NULL

Definition at line 138 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetLob ( OCI_Lob lob  ) 

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

Parameters:
lob - Lob handle
Returns:
OCI LobLocator handle otherwise NULL

Definition at line 154 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetFile ( OCI_File file  ) 

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

Parameters:
file - File handle
Returns:
OCI LobLocator handle otherwise NULL

Definition at line 170 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetDate ( OCI_Date date  ) 

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

Parameters:
date - Date handle
Returns:
OCI Date handle otherwise NULL

Definition at line 186 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetTimestamp ( OCI_Timestamp tmsp  ) 

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

Parameters:
tmsp - Timesstamp handle
Returns:
OCI Datetime handle otherwise NULL

Definition at line 202 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetInterval ( OCI_Interval itv  ) 

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

Parameters:
itv - Interval handle
Returns:
OCI Interval handle otherwise NULL

Definition at line 218 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetObject ( OCI_Object obj  ) 

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

Parameters:
obj - Object handle
Returns:
OCI Object handle otherwise NULL

Definition at line 234 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetColl ( OCI_Coll coll  ) 

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

Parameters:
coll - Collection handle
Returns:
OCI Collection handle otherwise NULL

Definition at line 250 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetRef ( OCI_Ref ref  ) 

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

Parameters:
ref - Ref handle
Returns:
OCI Ref handle otherwise NULL

Definition at line 266 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetMutex ( OCI_Mutex mutex  ) 

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

Parameters:
mutex - Mutex handle
Returns:
OCI Mutex handle otherwise NULL

Definition at line 282 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetThreadID ( OCI_Thread thread  ) 

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

Parameters:
thread - Thread handle
Returns:
OCI Thread ID otherwise NULL

Definition at line 298 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetThread ( OCI_Thread thread  ) 

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

Parameters:
thread - Thread handle
Returns:
OCI Thread handle otherwise NULL

Definition at line 314 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetDirPathCtx ( OCI_DirPath dp  ) 

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

Parameters:
dp - DirectPath handle
Returns:
OCI DirectPath Context handle otherwise NULL

Definition at line 330 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetDirPathColArray ( OCI_DirPath dp  ) 

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

Parameters:
dp - DirectPath handle
Returns:
OCI DirectPath Column array handle otherwise NULL

Definition at line 346 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetDirPathStream ( OCI_DirPath dp  ) 

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

Parameters:
dp - DirectPath handle
Returns:
OCI DirectPath Stream handle otherwise NULL

Definition at line 362 of file handle.c.

OCI_EXPORT const void* OCI_API OCI_HandleGetSubscription ( OCI_Subscription sub  ) 

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

Parameters:
sub - Subscription handle
Returns:
OCI Subscription otherwise NULL

Definition at line 378 of file handle.c.