Skip Headers
Oracle® Call Interface Programmer's Guide
11g Release 2 (11.2)

Part Number E10646-06
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

19 OCI Data Type Mapping and Manipulation Functions

This chapter describes the OCI data type mapping and manipulation functions. These functions are Oracle's external C language interface to Oracle Database predefined types.

See Also:

For code examples, see the demonstration programs included with your Oracle Database installation. For additional information, see Appendix B.

This chapter contains these topics:

Introduction to Data Type Mapping and Manipulation Functions

This chapter describes the OCI data type mapping and manipulation functions in detail.

See Also:

Chapter 12 for more information about the functions listed in this chapter

Conventions for OCI Functions

The entries for each function contain the following information:

Purpose

A brief statement of the purpose of the function.

Syntax

The function declaration.

Parameters

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 19-1.

Table 19-1 Mode of a Parameter

Mode Description

IN

A parameter that passes data to the OCI

OUT

A parameter that receives data from the OCI on this call

IN/OUT

A parameter that passes data on the call and receives data on the return from this or a subsequent call


Comments

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.

Returns

A description of what value is returned by the function if the function returns something other than the standard return codes listed in "Function Return Values".

Related Functions

A list of related functions.

Data Type Mapping and Manipulation Function Return Values

The OCI data type mapping and manipulation functions typically return one of the values shown in Table 19-2.

Table 19-2 Function Return Values

Return Value Meaning

OCI_SUCCESS

The operation succeeded.

OCI_ERROR

The operation failed. The specific error can be retrieved by calling OCIErrorGet() on the error handle passed to the function.

OCI_INVALID_HANDLE

The OCI handle passed to the function is invalid.


See Also:

"Error Handling in OCI" for more information about return codes and error handling

Functions Returning Other Values

Some functions return values other than those listed in Table 19-2. When you use the following functions, consider that they return a value directly from the function call, rather than through an OUT parameter.

Server Round-Trips for Data Type Mapping and Manipulation Functions

For a table showing the number of server round-trips required for individual OCI data type mapping and manipulation functions, see Table C-5.

Examples

For more information about these functions, including some code examples, see Chapter 12.