Skip Headers

Oracle® Call Interface Programmer's Guide
10g Release 1 (10.1)

Part Number B10779-01
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Index
Go to Master Index
Master Index
Go to Feedback page

Go to previous page
Go to current chapter
Go to next page
View PDF

Introduction to the Relational Functions

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"

Function Syntax

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.

Table 15-1 Mode of a Parameter  
Mode Description


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.

Related Functions

A list of related function calls.

Calling OCI Functions

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:

Server Round Trips for LOB Functions

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".