This chapter describes the OCI datatype mapping and manipulation functions, which is Oracle's external C Language interface to Oracle predefined types.
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 datatype mapping and manipulation functions in detail.
See Also:For more information about the functions listed in this chapter, refer to Chapter 12, "Object-Relational Datatypes in OCI"
The entries for each function contain the following information:
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 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:
A description of what value is returned by the function if the function returns something other than the standard return codes listed in Table 19-2, "Function Return Values".
The OCI datatype mapping and manipulation functions typically return one of the following values:
The operation succeeded
The operation failed. The specific error can be retrieved by calling
The OCI handle passed to the function is invalid.
Function-specific return information follows the description of each function in this chapter.
See Also:For more information about return codes and error handling, see the section "Error Handling in OCI"
Some functions return values other than those listed in Table 19-2. When using these function be sure to take into account that they return a value directly from the function call, rather than through an OUT parameter.
For a table showing the number of server round trips required for individual OCI datatype mapping and manipulation functions, refer to Appendix C, "OCI Function Server Round Trips".
For more information about these functions, including some code examples, refer to Chapter 12, "Object-Relational Datatypes in OCI".