OCI XML DB Functions

This section describes the XML DB functions.

Table 22-3 XML DB Functions  

Function/Page	Purpose
OCIXmlDbFreeXmlCtx()	Free an XML context.
OCIXmlDbInitXmlCtx()	Initialize an XML context for XML data from the database.

OCIXmlDbFreeXmlCtx()

Purpose

Free any allocations made by the call to OCIXmlDbInitXmlCtx().

Syntax

void OCIXmlDbFreeXmlCtx ( xmlct   *xctx ); 

Parameters

xctx (IN)

The XML context to terminate.

Comments

None.

Related Functions

OCIXmlDbInitXmlCtx()

OCIXmlDbInitXmlCtx()

Purpose

To initialize an XML context for XML data from the database.

Syntax

xmlctx *OCIXmlDbInitXmlCtx (   OCIEnv                *envhp,
                               OCISvcCtx             *svchp,
                               OCIError              *errhp,
                               ocixmldbparam         *params,
                               ub4                   num_params ); 

Parameters

envhp (IN)

The OCI environment handle.

svchp (IN)

The OCI service handle.

errhp (IN)

The OCI error handle.

params (IN)

The optional possible values in this array are:

The OCI duration. Default value is OCI_DURATION_SESSION.

An error handler which is a user-registered callback of prototype:

void (*err_handler) (sword errcode, (CONST OraText *) errmsg);

The two parameters of err_handler are:

errcode (OUT)
A numerical error value.

errmsg (OUT)
The error message text.

num_params (IN)

Number of parameters to be read from params. If the value of num_params exceeds the size of array params, unexpected behavior results.

Comments

Returns

Returns either:

• A pointer to structure xmlctx, with error handler and callbacks populated with appropriate values. This is later used for all OCI calls.
• NULL, if no database connection is available.

Related Functions

OCIXmlDbFreeXmlCtx()