|Oracle Call Interface Programmer's Guide
Release 2 (9.2)
Part Number A96584-01
OCI Relational Functions, 36 of 38
Sets up additional attributes necessary for a named data type or
sword OCIDefineObject ( OCIDefine *defnp, OCIError *errhp, CONST OCIType *type, dvoid **pgvpp, ub4 *pvszsp, dvoid **indpp, ub4 *indszp );
A define handle previously allocated in a call to
An error handle you can pass to
OCIErrorGet() for diagnostic information in the event of an error.
Points to the Type Descriptor Object (TDO) which describes the type of the program variable. Only used for program variables of type SQLT_NTY. This parameter is optional, and may be passed as null if it is not being used.
Points to a pointer to a program variable buffer. For an array,
pgvpp points to an array of pointers. Memory for the fetched named data type instance(s) is dynamically allocated in the object cache. At the end of the fetch when all the values have been received,
pgvpp points to the pointer(s) to these newly allocated named data type instance(s). The application must call
OCIObjectFree() to deallocate the named data type instance(s) when they are no longer needed.
If the application wants the buffer to be implicitly allocated in the cache,
Points to the size of the program variable. For an array, it is an array of ub4s.
Points to a pointer to the program variable buffer containing the parallel indicator structure. For an array, points to an array of pointers. Memory is allocated to store the indicator structures in the object cache. At the end of the fetch when all values have been received,
indpp points to the pointer(s) to these newly allocated indicator structure(s).
Points to the size(s) of the indicator structure program variable. For an array, it is an array of ub4s.
This function follows a call to
OCIDefineByPos() to set initial define information. This call sets up additional attributes necessary for a Named Data Type define. An error will be returned if this function is called when the OCI environment has been initialized in non-Object mode.
This call takes as a parameter a type descriptor object (TDO) of datatype OCIType for the named data type being defined. The TDO can be retrieved with a call to
See the description of