23 OCI XML DB Functions

This chapter describes the OCI XML DB functions.

This chapter contains these topics:

Introduction to XML DB Support in OCI

This chapter describes the XML DB functions in detail.

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 below:

Table 23-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. An optional section.

All the functions in this chapter are related to each other.

Function Return Values

Unless otherwise stated, the function returns:

Table 23-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:

For more information about return codes and error handling, see the section "Error Handling in OCI"