|Oracle Call Interface Programmer's Guide
Release 2 (9.2)
Part Number A96584-01
OCI Navigational and Type Functions, 33 of 36
Get an array of types given an array of names.
sword OCITypeArrayByName ( OCIEnv *envhp, OCIError *errhp, CONST OCISvcCtx *svc, ub4 array_len, CONST text *schema_name, ub4 s_length, CONST text *type_name, ub4 t_length, CONST text *version_name, ub4 v_length, OCIDuration pin_duration, OCITypeGetOpt get_option, OCIType *tdo );
The OCI error handle. If there is an error, it is recorded in
err and this function returns OCI_ERROR. Obtain diagnostic information by calling
OCI service handle.
schema_name/type_name/version_name entries to be retrieved.
Array of schema names associated with the types to be retrieved. The array must have
array_len elements if specified. If 0 is supplied, the default schema is assumed, otherwise it must have
array_len number of elements. 0 can be supplied for one or more of the entries to indicate that the default schema is desired for those entries.
schema_name lengths with each entry corresponding to the length of the corresponding
schema_name entry in the
schema_name array in bytes. The array must either have
array_len number of elements or it must be 0 if
schema_name is not specified.
Array of the names of the types to retrieve. This must have
array_len number of elements.
Array of the lengths of type names in the
type_name array in bytes.
The version name is ignored and the latest version of the requested type is returned. Because type evolution is available starting in release 9.0, pre-9.0 applications attempting to access an altered type will generate an error. These applications must be modified, re-compiled, and re-linked using the new type definition.
Array of the version names of the types to retrieve corresponding. This can be 0 to indicate retrieval of the most current versions, or it must have
array_len number of elements.
If 0 is supplied, the most current version is assumed, otherwise it must have
array_len number of elements. 0 can be supplied for one or more of the entries to indicate that the current version is desired for those entries.
Array of the lengths of version names in the
version_name array in bytes.
Pin duration (for example, until the end of current transaction) for the types retrieved. See
oro.h for a description of each option.
Options for loading the types. It can be one of two values:
Output array for the pointers to each pinned type in the object cache. It must have space for
array_len pointers. Use
OCIObjectGetObjectRef() to obtain the CREF to each pinned type descriptor.
Gets pointers to the existing types associated with the schema/type name array.
get_option parameter can be used to control the portion of the TDO that gets loaded for each round-trip.
This function returns an error if any of the required parameters is null or any object types associated with a schema/type name entry do not exist.
To retrieve a single type, rather than an array, use