20
OCI Any Type and Data Functions

This chapter describes the OCI Any Type and Data functions.

The following sections are included in this chapter:

• Introduction to Any Type and Data Interfaces
• OCI Type Interface Functions
• OCI Any Data Interface Functions
• OCI Any Data Set Interface Functions

Introduction to Any Type and Data Interfaces

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

The Function Syntax

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:

Mode	Description
IN	A parameter that passes data to Oracle
OUT	A parameter that receives data from Oracle on this or a subsequent 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

The OCI Any Type and Data functions typically return one of the following values:

Table 20-1 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.

OCI Type Interface Functions

This section describes the Type Interface functions.

Table 20-2 Type Interface Functions  

Function/Page	Purpose
OCITypeAddAttr()	Adds an attribute to an object type that was constructed earlier with typecode OCI_TYPECODE_OBJECT.
OCITypeBeginCreate()	Begins the construction process for a transient type. The type will be anonymous (no name).
OCITypeEndCreate()	Finishes construction of a type description. Subsequently, only access will be allowed.
OCITypeSetBuiltin()	Sets built-in type information. This call can be made only if the type has been constructed with a built-in typecode (OCI_TYPECODE_NUMBER, etc.)
OCITypeSetCollection()	Sets collection type information. This call can be made only if the type has been constructed with a collection typecode.