Release 8.1.5
A67846-01
 Library |
 Product |
 Contents |
 Index |
| Oracle Call Interface Programmer's Guide Release 8.1.5 A67846-01 |
|
This appendix describes the attributes for OCI handles and descriptors, which can be read with OCIAttrGet(), and modified with OCIAttrSet().
For each handle type, the attributes which can be read or changed are listed. Each attribute listing includes the following information:
The following modes are possible:
READ - the attribute can be read using OCIAttrGet()
WRITE - the attribute can be modified using OCIAttrSet()
READ/WRITE - the attribute can be read using OCIAttrGet(), and it can be modified using OCIAttrSet().
This is a description of the purpose of the attribute.
This is the datatype of the attribute. If necessary, a distinction is made between the datatype for READ and WRITE modes.
In some cases, only certain values are allowed, and they are listed here.
In some cases an example is included.
READ/WRITE
When this attribute is set to TRUE, during OCICacheFlush() the objects that belong to the same table are flushed together, which can considerably improve performance. This mode should only be used when the order in which the objects are flushed is not important. During this mode it is not guaranteed that the order in which the objects are marked dirty is preserved. See "Object Cache Parameters" and "Flushing Changes to Server" for more information.
boolean
READ/WRITE
Sets the maximum size (high watermark) for the client-side object cache as a percentage of the optimal size. The default value is 10%. See the section "Object Cache Parameters" for more information.
ub4 *
READ/WRITE
Sets the optimal size for the client-side object cache in bytes. The default value is 200k bytes. See the section "Object Cache Parameters" for more information.
ub4 *
READ
Returns TRUE if the environment was initialized in object mode.
boolean *
READ/WRITE
This attribute sets the value of OCI_PIN_DEFAULT for the application associated with the environment handle.
For example, if OCI_ATTR_PINOPTION is set to OCI_PIN_RECENT, then if OCIObjectPin() is called with the pin_option parameter set to OCI_PIN_DEFAULT, then the object is pinned in OCI_PIN_RECENT mode.
OCIPinOpt *
READ/WRITE
This attribute sets the value of OCI_DURATION_DEFAULT for allocation durations for the application associated with the environment handle.
OCIDuration *
READ/WRITE
This attribute sets the value of OCI_DURATION_DEFAULT for pin durations for the application associated with the environment handle.
OCIDuration *
READ
The current size of the memory allocated from the environment handle. This may help you track where memory is being used most in an application.
ub4 *
READ/WRITE
When this attribute is set to TRUE, newly created objects have non-NULL attributes. For more information refer to "Creating Objects".
boolean *
READ/WRITE
When this attribute is set to TRUE, applications receive an ORA-08179 error when attempting to flush an object which has been modified in the server by another committed transaction.
For more information, refer to "Implementing Optimistic Locking".
boolean *
READ
Returns the size of the memory currently allocated from the shared pool. This attribute works on any environment handle but the process must be initialized in shared mode to return a meaningful value. This attribute is read as follows:
ub4 heapsz = 0; OCIAttrGet((dvoid *)envhp, (ub4)OCI_HTYPE_ENV, (dvoid *) &heapsz, (ub4 *) 0, (ub4)OCI_ATTR_SHARED_HEAPALLOC, errhp);
ub4 *
READ
Returns the offset (into the DML array) at which the error occurred.
ub4 *
READ
returns the environment context associated with the service context.
OCIEnv **
READ/WRITE
When read, returns the pointer to the server context attribute of the service context.
When changed, sets the server context attribute of the service context.
OCIServer ** (READ) / OCIServer * (WRITE)
READ/WRITE
When read, returns the pointer to the authentication context attribute of the service context.
When changed, sets the authentication context attribute of the service context.
OCISession ** (READ) / OCISession * (WRITE)
READ/WRITE
When read, returns the pointer to the transaction context attribute of the service context.
When changed, sets the transaction context attribute of the service context.
OCITrans ** (READ) / OCITrans * (WRITE)
READ
Allows you to determine whether an application has switched to Oracle release 7 mode (e.g., through an OCISvcCtxToLda() call). A non-zero (true) return value indicates that the application is currently running in Oracle release 8 mode, a zero (false) return value indicates that the application is currently running in Oracle release 7 mode.
ub1 *
The following code sample shows how this parameter might be used:
in_v8_mode = 0; OCIAttrGet ((dvoid *)svchp, (ub4)OCI_HTYPE_SVCCTX, (ub1 *)&in_v8_mode, (ub4) 0, OCI_ATTR_IN_V8_MODE, errhp); if (in_v8_mode) fprintf (stdout, "In V8 mode\n"); else fprintf (stdout, "In V7 mode\n");
READ/WRITE
This attribute determines the blocking mode.
When read, the attribute value returns TRUE if the server context is in non-blocking mode. When set, it toggles the non-blocking mode attribute. See "Non-Blocking Mode" for more information.
The attribute value is of type ub1.
READ
Returns the environment context associated with the server context.
OCIEnv **
READ/WRITE
The external name is the user-friendly global name stored in sys.props$.value$ where name = 'GLOBAL_DB_NAME'. It is not guaranteed to be unique unless all databases register their names with a network directory service.
Database names can be exchanged with the server in case of distributed transaction coordination. Server database names can only be accessed if the database is open at the time the OCISessionBegin() call is issued.
text ** (READ) / text * (WRITE)
READ/WRITE
Sets the client database name that will be recorded when performing global transactions. The name can be used by the DBA to track transactions that may be pending in a prepared state due to failures.
text ** (READ) / text * (WRITE)
READ
Allows you to determine whether an application has switched to Oracle release 7 mode (e.g., through an OCISvcCtxToLda() call). A non-zero (true) return value indicates that the application is currently running in Oracle release 8 mode, a zero (false) return value indicates that the application is currently running in Oracle release 7 mode.
ub1 *
READ/WRITE
See "Application Failover Callbacks" for more information.
OCIFocbkStruct *
READ/WRITE
An alpha-numeric string not exceeding 30 characters specifying the server group. See "Password and Session Management" for more information.
ub4
WRITE
Specifies a username to use for authentication.
text *
READ/WRITE
Specifies the session identified for the session handle. Allows you to clone a session from one environment to another, in the same process or between processes. These processes can be on the same machine or different machines. For a session to be cloned, the session must be authenticated as migratable. See "Password and Session Management" for more information.
ub1 *
The following code sample shows how this attribute might be used:
OCIAttrSet ((dvoid *) authp, (ub4) OCI_HTYPE_SESSION, (dvoid *) mig_session, (ub4) sz, (ub4) OCI_ATTR_MIGSESSION, errhp);
WRITE
Specifies a password to use for authentication.
text *
READ/WRITE
Can be used to establish or read a text string which identifies a transaction. This is an alternative to using the XID to identify the transaction. The text string can be up to 64 bytes long.
text ** (READ) / text * (WRITE)
READ/WRITE
Can set or read an XID which identifies a transaction.
XID ** (READ) / XID * (WRITE)
READ
Returns the number of errors in the DML operation.
ub4 *
READ
Returns the number of rows processed so far. The default value is 1.
ub4 *
READ
Returns the function code of the SQL command associated with the statement.
ub2 *
The SQL command codes are listed in Table A-1, "SQL Command Codes".
READ
Returns the environment context associated with the statement.
OCIEnv **
READ
The type of statement associated with the handle. Possible values are:
ub2 *
READ
Returns the ROWID descriptor allocated with OCIDescriptorAlloc(). For additional information, see "Positioned Updates and Deletes" and "ROWID".
OCIRowid *
READ
This attribute can be used to get the number of columns in the select-list for the statement associated with the statement handle.
ub4 *
The following code sample shows how this attribute might be used:
/* Describe of a select-list */ text *selstmt = "SELECT * FROM EMP"; ub4 parmcnt; OCIParam *parmdp; err = OCIStmtPrepare (stmhp, errhp, selstmt, (ub4)strlen((char *)selstmt), (ub4) OCI_NTV_SYNTAX, (ub4) OCI_DEFAULT); err = OCIStmtExecute (svchp, stmhp, errhp, (ub4)1, (ub4)0, (const OCISnapshot*) 0, (OCISnapshot*)0, OCI_DESCRIBE_ONLY); /* get the number of columns in the select list */ err = OCIAttrGet ((dvoid *)stmhp, (ub4)OCI_HTYPE_STMT, (dvoid *) &parmcnt, (ub4 *) 0, (ub4)OCI_ATTR_PARAM_COUNT, errhp); /* get describe information for each column */ for (i = 0; i < parmcnt; i++) { OCIParamGet (dvoid *)stmhp, OCI_HTYPE_STMT, errhp, &parmdp, i); /* get the attributes for each column */ }
WRITE
Sets the number of top level rows to be prefetched. The default value is 1 row.
ub4 *
WRITE
Sets the memory level for top level rows to be prefetched. Rows up to the specified top level row count are fetched if it occupies no more than the specified memory usage limit. The default value is 0, which means that memory size is not included in computing the number of rows to prefetch.
ub4 *
READ
Returns the parse error offset for a statement.
WRITE
See "Character Count Attribute".
ub4 *
READ/WRITE
Character set ID of the bind handle. If the character set of the input data is UCS-2 (Unicode), the user has to set the character set Id to OCI_UCS2ID. The bind value buffer is assumed to be a utext buffer and length semantics for input length pointers and return values changes to character semantics (number of utexts). However the size of the bind value buffer in the preceeding OCIBind call has to be stated in bytes. For more information, see "Fixed Width Unicode Support".
When changing the character set on an bind handle, it is necessary to explicitly state the maximum length of the corresponding column in the database (schema definition). This is done using OCIAttrSet() and specifying the value of the OCI_ATTR_MAXDATA_SIZE attribute on the define handle.
ub2 *
READ/WRITE
Character set form of the bind handle.
ub1 *
READ/WRITE
See "OCI_ATTR_MAXDATA_SIZE Attribute".
sb4 *
WRITE
Specifies packed decimal precision. For SQLT_PDN values, the precision should be equal to 2*(value_sz-1). For SQLT_SLS values, the precision should be equal to (value_sz-1).
After a bind or define, this value is initialized to zero. The OCI_ATTR_PDPRC attribute should be set first, followed by OCI_ATTR_PDSCL. If either of these values needs to be changed, a rebind/redefine should be done first, and then the two attributes should be reset in order.
ub2 *
WRITE
Specifies the scale for packed decimal values.
After a bind or define, this value is initialized to zero. The OCI_ATTR_PDPRC attribute should be set first, followed by OCI_ATTR_PDSCL. If either of these values needs to be changed, a rebind/redefine should be done first, and then the two attributes should be reset in order.
sb2 *
READ
This attribute returns the number of rows that are going to be returned in the current iteration when we are in the OUT callback function for binding a DML statement with RETURNING clause.
ub4 *
WRITE
Sets the number of characters in a character type data. This specifies the number of characters desired in the define buffer. The define buffer length as specified in the define call must be greater than number of characters.
ub4 *
READ/WRITE
The character set ID of the define handle. If the character set of the output data should be UCS-2 (Unicode), the user has to set the character set Id to OCI_UCS2ID. The define value buffer is assumed to be a utext buffer and length semantics for indicators and return values changes to character semantics (number of utexts). However the size of the define value buffer in the preceeding OCIDefine call has to be stated in bytes. For more information, see "Fixed Width Unicode Support".
ub2 *
READ/WRITE
The character set form of the define handle.
ub1 *
WRITE
Specifies packed decimal precision. For SQLT_PDN values, the precision should be equal to 2*(value_sz-1). For SQLT_SLS values, the precision should be equal to (value_sz-1).
After a bind or define, this value is initialized to zero. The OCI_ATTR_PDPRC attribute should be set first, followed by OCI_ATTR_PDSCL. If either of these values needs to be changed, a rebind/redefine should be done first, and then the two attributes should be reset in order.
ub2 *
WRITE
Specifies the scale for packed decimal values.
After a bind or define, this value is initialized to zero. The OCI_ATTR_PDPRC attribute should be set first, followed by OCI_ATTR_PDSCL. If either of these values needs to be changed, a rebind/redefine should be done first, and then the two attributes should be reset in order.
sb2 *
READ
Points to the root of the description. Used for subsequent calls to OCIAttrGet() and OCIParamGet().
ub4 *
READ
Returns the number of parameters in the describe handle. When the describe handle is a description of the select list, this refers to the number of columns in the select list.
ub4 *
For a detailed list of parameter descriptor attributes, refer to Chapter 6, "Describing Schema Metadata".
WRITE
Sets the internal LOB locator to empty. The locator can then be used as a bind variable for an INSERT or UPDATE statement to initialize the LOB to empty. Once the LOB is empty, OCILobWrite() can be called to populate the LOB with data. This attribute is only valid for internal LOBs (i.e., BLOB, CLOB, NCLOB).
Applications should pass address of a ub4 which has a value of 0; e.g., declare
ub4 lobEmpty = 0
then pass address &lobEmpty.
ub4 *
For information about complex object retrieval, see "Complex Object Retrieval".
WRITE
The depth level for complex object retrieval.
ub4 *
WRITE
Whether to fetch collection attributes in an object type out-of-line.
ub1 *
WRITE
A type of REF to follow for complex object retrieval.
dvoid *
WRITE
Depth level for following REFs of type OCI_ATTR_COMPLEXOBJECT_COMP_TYPE.
ub4 *
For more information about Advanced Queueing, properties, and options, refer to the Advanced Queueing chapter of the Oracle8i Application Developer's Guide - Fundamentals.
The following attributes are properties of the OCIAQEnqOptions descriptor:
READ/WRITE
Specifies the message identifier of the message which is referenced in the sequence deviation operation. This value is valid if and only if OCI_ENQ_BEFORE is specified in OCI_ATTR_SEQUENCE_DIVISION. This value is ignored if the sequence deviation is not specified.
OCIRaw *
READ/WRITE
Specifies whether the message being enqueued should be dequeued before other message(s) already in the queue.
ub4
The only valid values are:
READ/WRITE
Specifies the transactional behavior of the enqueue request.
ub4
The only valid values are:
The following attributes are properties of the OCIAQDeqOptions descriptor:
READ/WRITE
Name of the consumer. Only those messages matching the consumer name are accessed. If a queue is not set up for multiple consumers, this field should be set to NULL.
text *
READ/WRITE
Specifies the correlation identifier of the message to be dequeued. Special pattern matching characters, such as the percent sign (%) and the underscore (_) can be used. If more than one message satisfies the pattern, the order of dequeuing is undetermined.
text *
READ/WRITE
Specifies the locking behavior associated with the dequeue.
ub4
The only valid values are:
READ/WRITE
Specifies the message identifier of the message to be dequeued.
OCIRaw *
READ/WRITE
Specifies the position of the message that will be retrieved. First, the position is determined. Second, the search criterion is applied. Finally, the message is retrieved.
ub4
The only valid values are:
READ/WRITE
Specifies whether the new message is dequeued as part of the current transaction.The visibility parameter is ignored when using the BROWSE mode.
ub4
The only valid values are:
READ/WRITE
Specifies the wait time if there is currently no message available which matches the search criteria. This parameter is ignored if messages in the same group are being dequeued.
ub4
Any ub4 value is valid, but the following predefined constants are provided:
The following attributes are properties of the OCIAQMsgProperties descriptor:
READ
Specifies the number of attempts that have been made to dequeue the message. This parameter cannot be set at enqueue time.
sb4
Any sb4 value is valid.
READ/WRITE
Specifies the identification supplied by the producer for a message at enqueuing.
text *
Any string up to 128 bytes is valid.
READ/WRITE
Specifies the number of seconds to delay the enqueued message. The delay represents the number of seconds after which a message is available for dequeuing. Dequeuing by msgid overrides the delay specification. A message enqueued with delay set will be in the WAITING state, when the delay expires the messages goes to the READY state. DELAY processing requires the queue monitor to be started. Note that delay is set by the producer who enqueues the message.
sb4
Any sb4 value is valid, but the following predefined constant is available:
READ
Specifies the time the message was enqueued. This value is determined by the system and cannot be set by the user.
OCIDate
READ/WRITE
Specifies the name of the queue to which the message is moved to if it cannot be processed successfully. Messages are moved in two cases: If the number of unsuccessful dequeue attempts has exceeded max_retries; or if the message has expired. All messages in the exception queue are in the EXPIRED state.
The default is the exception queue associated with the queue table. If the exception queue specified does not exist at the time of the move the message will be moved to the default exception queue associated with the queue table and a warning will be logged in the alert file. If the default exception queue is used, the parameter will return a NULL value at dequeue time.
This attribute must refer to a valid queue name.
text *
READ/WRITE
Specifies the expiration of the message. It determines, in seconds, the duration the message is available for dequeuing. This parameter is an offset from the delay. Expiration processing requires the queue monitor to be running.
While waiting for expiration, the message remains in the READY state. If the message is not dequeued before it expires, it will be moved to the exception queue in the EXPIRED state.
sb4
Any sb4 value is valid, but the following predefined constant is available:
READ
Specifies the state of the message at the time of the dequeue. This parameter cannot be set at enqueue time.
ub4
These are the only values which are returned:
READ/WRITE
Specifies the priority of the message. A smaller number indicates higher priority. The priority can be any number, including negative numbers.
The default value is zero.
sb4
WRITE
This parameter is only valid for queues which allow multiple consumers. The default recipients are the queue subscribers. This parameter is not returned to a consumer at dequeue time.
OCIAQAgent **
READ/WRITE
Identifies the original sender of a message.
OCIAgent *
READ/WRITE
The ID of the last queue that generated this message. When a message is propagated from one queue to another, this attribute identifies the ID of the queue from which it was last propagated. When a message has been propagated through multiple queues, this attribute identifies the last queue, not the first queue.
OCIRaw *
The following attributes are properties of the OCIAQAgent descriptor:
READ/WRITE
Protocol-specific address of the recipient. If the protocol is 0 (default), the address is of the form [schema.]queue[@dblink].
text *
Can be any string up to 128 bytes.
READ/WRITE
Name of a producer or consumer of a message.
text *
Can be any Oracle identifier, up to 30 bytes.
READ/WRITE
Protocol to interpret the address and propagate the message. The default (and currently the only supported) value is 0.
ub1
The only valid value is zero, which is also the default.
See Also: For information about direct path loading and allocating the direct path handles, refer to "Publish-Subscribe Notification".
READ/WRITE
Subscription callback. This attribute needs to be set before the subscription handle can be passed into the registration call OCISubscriptionRegister().
OCISubscriptionNotify *
READ/WRITE
Context that the client wants to get passed to the user callback denoted by OCI_ATTR_SUBSCR_CALLBACK when it gets invoked by the system. This attribute needs to be set before the subscription handle can be passed into the registration call OCISubscriptionRegister().
dvoid *
READ/WRITE
Namespace in which the subscription handle is used. This release only supports OCI_SUBSCR_NAMESPACE_AQ and that value must be set explicitly. The subscription name that is set for the subscription handle must be consistent with its namespace.
ub4 *
READ/WRITE
Subscription name. All subscriptions are identified by a subscription name. A subscription name consists of a sequence of bytes of specified length. The length in bytes of the name needs to be specified as it is not assumed that the name will be null-terminated. This is important because the name could contain NLS characters.
Clients will be able to set the subscription name attribute of a Subscription handle using an OCIAttrSet() call and by specifying a handle type of OCI_HTYPE_SUBSCR and an attribute type of OCI_ATTR_SUBSCR_NAME.
All of the subscription callbacks need a subscription handle with the OCI_ATTR_SUBSCR_NAME and OCI_ATTR_SUBSCR_NAMESPACE attributes set. If the attributes are not set, an error is returned. The subscription name that is set for the subscription handle must be consistent with its namespace.
text *
READ/WRITE
Buffer that corresponds to the payload that needs to be sent along with the notification. The length of the buffer can also be specified in the same set attribute call. This attribute needs to be set before a post can be performed on a subscription. For this release, only an untyped (ub1 *) payload is supported.
ub1 *
See Also: For information about direct path loading and allocating the direct path handles, refer to "Direct Path Loading" .
READ/WRITE
Sets the size of the stream transfer buffer. Default value is 64KB.
ub4 */ub4 *
READ/WRITE
Default character set ID for the character data. Note that the character set ID can be overridden at the column level. If character set ID is not specified at the column level or the table level, then the NLS environment setting is used.
ub2 */ub2 *
READ/WRITE
Default date format string for SQLT_CHAR to DTYDAT conversions. Note that the date format string can be overridden at the column level. If date format string is not specified at the column level or the table level, then the NLS environment setting is used.
text **/text *
READ/WRITE
Mode of the direct path context:
ub1 */ub1 *
READ/WRITE
The NOLOG attribute of each segment determines whether image redo or invalidation redo is generated:
ub1 */ub1 *
READ/WRITE
Setting this value to 1 allows multiple load sessions to load the same segment concurrently. The default is 0 (not parallel).
ub1 */ub1 *
READ
Returns the handle to the parameter descriptor for the column list associated with the direct path context. The column list parameter descriptor can be retrieved after the number of columns is set with the OCI_ATTR_NUM_COLS attribute. See "Accessing Column Parameter Attributes".
OCIParam* *
READ/WRITE
Name of the table to be loaded.
text**/text *
READ/WRITE
Number of columns being loaded in the table.
ub2 */ub2 *
READ/WRITE
Name of the schema where the table being loaded resides. If not specified, the schema defaults to that of the connected user.
text **/text *
READ/WRITE
Name of the partition, or subpartition, to be loaded. If not specified, the entire table is loaded. The name must be a valid partition or subpartition name which belongs to the table.
text **/text *
READ
Last column of the last row processed.
ub2 *
READ
Column dimension of the column array.
ub2 *
READ
Row dimension of the column array.
ub4 *
READ
Last row processed.
ub4 *
READ
Buffer address of the beginning of the stream data.
ub1 **
READ
Size of the stream data in bytes.
ub4 *
READ
Column array index of the last row processed. This attribute is valid only if the data was sourced from a column array.
ub4 *
READ
Offset into the stream buffer of the last processed row.
ub4 *
The application specifies which columns are to be loaded, and the external format of the data by setting attributes on each column parameter descriptor. The column parameter descriptors are obtained as parameters of the column parameter list via OCIParamGet(). The column parameter list is obtained from the OCI_ATTR_LIST_COLUMNS attribute of the direct path context. Note that all parameters are 1-based.
The following code sample illustrates the use of the direct path column parameter attributes. Before the attributes are accessed, you must first set the number of columns to be loaded and get the column parameter list from the OCI_ATTR_LIST_COLUMNS attribute.
/* set number of columns to be loaded */ OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrSet((dvoid *)dpctx, (ub4)OCI_HTYPE_DIRPATH_CTX, (dvoid *)&tblp->ncol_tbl, (ub4)0, (ub4)OCI_ATTR_NUM_COLS, ctlp->errhp_ctl)); /* get the column parameter list */ OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrGet((dvoid *)dpctx, OCI_HTYPE_DIRPATH_CTX, (dvoid *)&ctlp->colLstDesc_ctl, (ub4 *)0, OCI_ATTR_LIST_COLUMNS, ctlp->errhp_ctl));
Now you can set the parameter attributes.
/* set the attributes of each column by getting a parameter handle on each * column, then setting attributes on the parameter handle for the column. * Note that positions within a column list descriptor are 1-based. */ for (i = 0, pos = 1, colp = tblp->col_tbl, fldp = tblp->fld_tbl; i < tblp->ncol_tbl; i++, pos++, colp++, fldp++) { /* get parameter handle on the column */ OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIParamGet((CONST dvoid *)ctlp->colLstDesc_ctl, (ub4)OCI_DTYPE_PARAM, ctlp->errhp_ctl, (dvoid **)&colDesc, pos)); colp->id_col = i; /* position in column array */ /* set external attributes on the column */ /* column name */ OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrSet((dvoid *)colDesc, (ub4)OCI_DTYPE_PARAM, (dvoid *)colp->name_col, (ub4)strlen((const char *)colp->name_col), (ub4)OCI_ATTR_NAME, ctlp->errhp_ctl)); /* column type */ OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrSet((dvoid *)colDesc, (ub4)OCI_DTYPE_PARAM, (dvoid *)&colp->exttyp_col, (ub4)0, (ub4)OCI_ATTR_DATA_TYPE, ctlp->errhp_ctl)); /* max data size */ OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrSet((dvoid *)colDesc, (ub4)OCI_DTYPE_PARAM, (dvoid *)&fldp->maxlen_fld, (ub4)0, (ub4)OCI_ATTR_DATA_SIZE, ctlp->errhp_ctl)); if (colp->datemask_col) /* set column (input field) date mask */ { OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrSet((dvoid *)colDesc, (ub4)OCI_DTYPE_PARAM, (dvoid *)colp->datemask_col, (ub4)strlen((const char *)colp->datemask_col), (ub4)OCI_ATTR_DATEFORMAT, ctlp->errhp_ctl)); } if (colp->prec_col) { OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrSet((dvoid *)colDesc, (ub4)OCI_DTYPE_PARAM, (dvoid *)&colp->prec_col, (ub4)0, (ub4)OCI_ATTR_PRECISION, ctlp->errhp_ctl)); } if (colp->scale_col) { OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrSet((dvoid *)colDesc, (ub4)OCI_DTYPE_PARAM, (dvoid *)&colp->scale_col, (ub4)0, (ub4)OCI_ATTR_SCALE, ctlp->errhp_ctl)); } if (colp->csid_col) { OCI_CHECK(ctlp->errhp_ctl, OCI_HTYPE_ERROR, ociret, ctlp, OCIAttrSet((dvoid *)colDesc, (ub4)OCI_DTYPE_PARAM, (dvoid *)&colp->csid_col, (ub4)0, (ub4)OCI_ATTR_CHARSET_ID, ctlp->errhp_ctl)); } /* free the parameter handle to the column descriptor */ OCI_CHECK((dvoid *)0, 0, ociret, ctlp, OCIDescriptorFree((dvoid *)colDesc, OCI_DTYPE_PARAM)); }
READ/WRITE
Character set ID for character column. If not set, the character set ID defaults to the character set ID set in the direct path context.
ub2 */ub2 *
READ/WRITE
Maximum size in bytes of the external data for the column. This can affect conversion buffer sizes.
ub4 */ub4 *
READ/WRITE
Returns or sets the external datatype of the column. Valid datatypes are: SQLT_CHR, SQLT_DAT, SQLT_INT, SQLT_UIN, SQLT_FLT, SQLT_PDN, SQLT_BIN, or SQLT_NUM.
ub2 */ub2 *
READ/WRITE
Date conversion mask for the column. If not set, the date format defaults to the date conversion mask set in the direct path context.
text **/text *
READ/WRITE
Returns or sets the name of the column that is being loaded.
text **/text *
READ/WRITE
Returns of sets the precision.
ub1 */ub1 *
READ/WRITE
Returns or sets the scale (number of digits to the right of the decimal point) for conversions from packed and zoned decimal input data types.
sb1 */sb1 *
The parameters for the shared system can be set and read using the OCIAttrSet() and OCIAttrGet() calls.The handle type to be used is the process handle OCI_HTYPE_PROC. Refer also to OCI_ATTR_SHARED_HEAP_ALLOC.
The OCI_ATTR_MEMPOOL_APPNAME, OCI_ATTR_MEMPOOL_HOMENAME, and OCI_ATTR_MEMPOOL_INSTNAME attributes specify the application, home, and instance names that can be used together to map the process to the right shared pool area. If these attributes are not provided, internal default values are used. The following are possible settings of the attributes for specific behaviors:
READ/WRITE
Executable name or fully-qualified path name of the executable.
text *
READ/WRITE
Directory name where the executables that use the same shared subsystem instance are located.
text *
READ/WRITE
Any user-defined name to identify an instance of the shared subsystem.
text *
READ/WRITE
Size of the shared pool in bytes. This attribute is set as follows:
ub4 plsz = 1000000; OCIAttrSet((dvoid *)0, (ub4) OCI_HTYPE_PROC, (dvoid *)&plsz, (ub4) 0, (ub4) OCI_ATTR_POOL_SIZE, 0)
ub4 *
READ
Returns all the currently set process modes. The value read contains the OR'ed value of all the currently set OCI process modes. To determine is a specific mode is set, the value should be OR'ed with that mode. For example:
ub4 mode; boolean is_shared; OCIAttrGet((dvoid *)0, (ub4)OCI_HTYPE_PROC, (dvoid *) &mode, (ub4 *) 0, (ub4)OCI_ATTR_PROC_MODE, 0); is_shared = (mode & OCI_SHARED);
ub4 *
