16
More OCI Relational Functions

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 the following sections:

Introduction to More Relational Functions

This chapter completes descriptions of the OCI relational function calls. It continues from the last chapter. The function calls for manipulating objects are described in the next three chapters.

See Also:

For information about return codes and error handling, refer to the section "Error Handling"

Function Syntax

For each function, the following information is listed:

Purpose

A brief description of the action performed by 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 below.

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

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.

Example

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 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, which are in characters.

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

Statement Functions

This section describes the statement functions.

Table 16-1 Statement Functions

Function	Purpose
`OCIStmtExecute()`	Send statements to server for execution
`OCIStmtFetch()`	Fetch rows from a query (deprecated)
`OCIStmtFetch2()`	Fetch rows from a query
`OCIStmtGetPieceInfo()`	Get piece information for piecewise operations
`OCIStmtPrepare()`	Prepares a SQL or PL/SQL statement for execution.
`OCIStmtPrepare2()`	Prepares a SQL or PL/SQL statement for execution.
`OCIStmtRelease()`	Releases the statement handle.
`OCIStmtSetPieceInfo()`	Set piece information for piecewise operations

16 More OCI Relational Functions