OCIDirPathLoadStream()

Purpose

Loads the data converted to direct path stream format.

Syntax

sword OCIDirPathLoadStream (   OCIDirPathCtx          *dpctx,
                               OCIDirPathStream       *dpstr,
                               OCIError               *errhp ); 

Parameters

dpctx (IN)

Direct path context handle for the object loaded.

dpstr (IN)

Direct path stream handle for the stream to load.

errhp (IN)

An error handle you can pass to OCIErrorGet() for diagnostic information in the event of an error.

Comments

When the interface returns an error, information concerning the row in the column array that sourced the stream can be obtained as an attribute of the direct path stream. Also, the offset into the stream where the error occurred can be obtained as an attribute of the stream.

Return codes for this function are:

• OCI_SUCCESS - All data in the stream was successfully loaded.
• OCI_ERROR - An error occurred while loading the data. The problem could be a partition mapping error, a null constraint violation, functional index evaluation error, or an out of space condition, such as cannot allocate extent. The attribute OCI_ATTR_STREAM_OFFSET of the direct path stream is the offset into the stream which corresponds to the offending row. OCI_ATTR_ROW_COUNT is the number of rows processed.
• OCI_NEED_DATA - Last row was not complete. The caller needs to supply another row piece. If the stream was sourced from a column array, the attribute OCI_ATTR_ROW_COUNT is the number of complete rows processed.
• OCI_NO_DATA - Attempt to load an empty stream, or a stream which has been completely processed.

Related Functions

OCIDirPathAbort(), OCIDirPathDataSave(), OCIDirPathFinish(), OCIDirPathPrepare(), OCIDirPathStreamReset()