OCI Cartridge Functions, 27 of 43

OCIExtractFromList()

Purpose

Generates a list of values for the parameter denoted by index in the parameter list.

Syntax

sword OCIExtractFromList( dvoid       *hndl, 
                          OCIError    *err, 
                          uword       index, 
                          text        **name, 
                          ub1         *type, 
                          uword       *numvals, 
                          dvoid       ***values );

Parameters

hndl (IN)

The OCI environment or user session handle.

err (IN/OUT)

The OCI error handle; if there is an error, it is recorded in err and this function returns OCI_ERROR; diagnostic information can be obtained by calling OCIErrorGet().

index (IN)

Which parameter to retrieve from the parameter list.

name (OUT)

The name of the key for the current parameter.

type (OUT)

Type of the current parameter:

OCI_EXTRACT_TYPE_STRING,

OCI_EXTRACT_TYPE_INTEGER,

OCI_EXTRACT_TYPE_OCINUM,

OCI_EXTRACT_TYPE_BOOLEAN.

numvals (OUT)

Number of values for this parameter.

values (OUT)

The values for this parameter.

Comments

OCIExtractToList() must be called prior to calling this routine to generate the parameter list from the parameter structures that are stored in memory.

Returns

OCI_SUCCESS,

OCI_INVALID_HANDLE,

OCI_ERROR.

Cartridge Services -- File I/O Interface

Table 19-5 File I/O Interface Functions

Function/Page	Purpose
`OCIFileInit()`	Initializes the OCIFile package.
`OCIFileTerm()`	Terminates the OCIFile package.
`OCIFileOpen()`	Opens a file.
`OCIFileClose()`	Closes a previously opened file.
`OCIFileRead()`	Reads from a file into a buffer.
`OCIFileWrite()`	Writes buflen bytes into the file.
`OCIFileSeek()`	Changes the current position in a file.
`OCIFileExists()`	Tests to see if the file exists.
`OCIFileGetLength()`	Gets the length of a file.
`OCIFileFlush()`	Writes buffered data to a file.

See Also:

For more information about using these functions, seeOracle9i Data Cartridge Developer's Guide

OCIFileObject

The OCIFileObject data structure holds information about the way in which a file should be opened and the way in which it will be accessed once it has been opened. When this structure is initialized by OCIFileOpen(), it becomes an identifier through which operations can be performed on that file. It is a necessary parameter to every function that operates on open files. This data structure is opaque to OCIFile clients. It is initialized by OCIFileOpen() and terminated by OCIFileClose().