This chapter begins to describe the Oracle Database Access C API and in particular the OCI relational functions for C.
This chapter includes information about calling OCI functions in your application, along with detailed descriptions of each function call.
For code examples, see the demonstration programs included with your Oracle Database installation. For additional information, see OCI Demonstration Programs.
This chapter contains these topics:
Introduces OCI relational function calls.
This chapter and More Oracle Database Access C API describe the OCI relational function calls and cover the functions in the basic OCI.
Error Handling in OCI for information about return codes and error handling
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 in Table 16-1.
Table 16-1 Mode of a Parameter
A parameter that passes data to the OCI
A parameter that receives data from the OCI on this call
A parameter that passes data on the call and receives data on the return from this or a subsequent call
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.
This optional section describes the possible values that can be returned. It can be found either before or after the Comments section.
A complete or partial code example demonstrating the use of the function call being described. Not all function descriptions include an example.
Unlike earlier versions of OCI, in and after release 8, you cannot pass -1 for the string length parameter of a
NULL-terminated string. When you pass string lengths as parameters, do not include the
NULL terminator byte in the length. The OCI does not expect strings to be
amount parameters in some LOB calls are in characters
UTF-16 encoding of text is used in function parameters, the length is in character points
Indicates the number of server round-trips required for individual OCI LOB functions.
For a table showing the number of server round-trips required for individual OCI LOB functions, see OCI Function Server Round-Trips.