The OCI external procedure functions for C:
Table 19-2 External Procedures Functions
Function/Page | Purpose |
---|---|
Allocates memory for the duration of the External Procedure |
|
Raises an Exception to PL/SQL |
|
Raises an exception with a message |
|
Gets the OCI environment, service context, and error handles |
Allocate N bytes of memory for the duration of the External Procedure.
dvoid * OCIExtProcAllocCallMemory ( OCIExtProcContext *with_context, size_t amount ); Parameters
The with_context
pointer that is passed to the C External Procedure.
See Also:
"With_Context Type"The number of bytes to allocate.
This call allocates amount
bytes of memory for the duration of the call of the external procedure.
Any memory allocated by this call is freed by PL/SQL upon return from the external procedure. The application must not use any kind of free()
function on memory allocated by OCIExtProcAllocCallMemory()
. Use this function to allocate memory for function returns.
A zero return value should be treated as an error
An untyped (opaque) Pointer to the allocated memory.
text *ptr = (text *)OCIExtProcAllocCallMemory(wctx, 1024)
OCIErrorGet(), OCIMemoryAlloc().
Raise an Exception to PL/SQL.
size_t OCIExtProcRaiseExcp ( OCIExtProcContext *with_context, int errnum ); Parameters
The with_context
pointer that is passed to the C External Procedure.
See Also:
"With_Context Type"Oracle Error number to signal to PL/SQL. errnum
must be a positive number and in the range 1 to 32767.
Calling this function signals an exception back to PL/SQL. After a successful return from this function, the external procedure must start its exit handling and return back to PL/SQL. Once an exception is signalled to PL/SQL, IN/OUT and OUT arguments, if any, are not processed at all.
This function returns OCIEXTPROC_SUCCESS if the call was successful. It returns OCIEXTPROC_ERROR if the call has failed.
Raise an exception with a message.
size_t OCIExtProcRaiseExcpWithMsg ( OCIExtProcContext *with_context, int errnum, char *errmsg, size_t msglen );
The with_context
pointer that is passed to the C External Procedure.
See Also:
"With_Context Type"Oracle Error number to signal to PL/SQL. The value of errnum
must be a positive number and in the range 1 to 32767
The error message associated with the errnum
.
The length of the error message. Pass zero if errmsg
is a NULL
-terminated string.
Raise an exception to PL/SQL. In addition, substitute the following error message string within the standard Oracle error message string.
See Also:
See the description of OCIExtProcRaiseExcp() for more information.This function returns OCIEXTPROC_SUCCESS if the call was successful. It returns OCIEXTPROC_ERROR if the call has failed.
Gets the OCI environment, service context, and error handles.
sword OCIExtProcGetEnv ( OCIExtProcContext *with_context, OCIEnv envh, OCISvcCtx svch, OCIError errh ); Parameters
The with_context
pointer that is passed to the C External Procedure. See "With_Context Type".
The OCI Environment handle.
The OCI Service handle.
The OCI Error handle.
The primary purpose of this function is to allow OCI callbacks to use the database in the same transaction. The OCI handles obtained by this function should be used in OCI callbacks to the database. If these handles are obtained through standard OCI calls, then these handles use a new connection to the database and cannot be used for callbacks in the same transaction. In one external procedure you can use either callbacks or a new connection, but not both.
This function returns OCI_SUCCESS
if the call was successful; otherwise, it returns OCI_ERROR
.