Oracle® Call Interface Programmer's Guide 10g Release 1 (10.1) Part Number B10779-01 |
|
|
View PDF |
This chapter first describes the OCI external procedure functions. These functions enable users of external procedures to raise errors, allocate some memory, and get OCI context information.
See Also:
For more information about using these functions in external procedures, see the chapter on external routines in Oracle Database Application Developer's Guide - Fundamentals |
Then the cartridge services functions are described.
See Also:
For more information about using these functions, see Oracle Data Cartridge Developer's Guide |
For each function, the following information is listed:
A brief description of the action performed by the function.
The function declaration.
A description of each of the function's parameters. This includes the parameter's mode. The mode of a parameter has three possible values, as described next:
More detailed information about the function (if available). This may include restrictions on the use of the function, or other information that might be useful when using the function in an application.
A list of possible return values for the function.
A list of related function calls. For cartridge services, see all the other functions in the group being documented.
Success and error return codes are defined for certain external procedure interface functions. If a particular interface function returns OCIEXTPROC_SUCCESS or OCIEXTPROC_ERROR, then applications must use these macros to check for return values.
The C callable interface to PL/SQL external procedures requires the with_context
parameter to be passed. The type of this structure is OCIExtProcContext
, which is opaque to the user.
The user can declare the with_context
parameter in the application as
OCIExtProcContext *with_context;