Oracle® Call Interface Programmer's Guide, 11g Release 2 (11.2) Part Number E10646-02 |
|
|
View PDF |
This chapter completes description of the OCI relational functions started in the last chapter. It includes information about calling OCI functions in your application, along with detailed descriptions of each function call.
See Also:
For code examples, see the demonstration programs included with your Oracle installation. For additional information, refer to Appendix B, "OCI Demonstration Programs".This chapter contains these topics:
This chapter describes the OCI relational function calls. This chapter and the next, cover the functions in the basic OCI.
See Also:
For information about return codes and error handling, refer to the section "Error Handling in OCI"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.
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 the 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 NULL
-terminated.
Buffer lengths that are OCI parameters are in bytes, except:
the amount
parameters in some LOB calls are in characters,
when UTF-16 encoding of text is used in function parameters, the length is in character points.
For a table showing the number of server round trips required for individual OCI LOB functions, refer to Appendix C, "OCI Function Server Round Trips".