OCI_oopt

function

Library: Oracle Call Interface database support (OMOCI legacy)
Include: omoci.xin

Returns: OCI_SUCCESS if the function completes without error.

Declaration

define external integer function OCI_oopt
   (  value OCI_Handle_type cursor,
      value integer rbopt,
      value integer waitopt
   )

Purpose

This function sets rollback options for non-fatal Oracle errors involving multi-row "insert" and "update sql" statements. It also sets wait options (for example, whether to wait for locks) in cases where requested resources are not available.

Input arguments:

cursor -- Cursor data area descriptor.
rbopt -- The action to be taken when a non-fatal Oracle error occurs. The following values are allowed:
- OCI_ROLLBACK_TRANSACTION -- All errors cause the current transaction to be rolled back.
- OCI_ROLLBACK_ROW -- The failing row will be rolled back on non-fatal row-level errors. This is the default.
waitopt -- Action to perform when resources are unavailable. The following values are allowed:
- OCI_WAIT -- Wait indefinitely if resources are not available. This is the default.
- OCI_NOWAIT -- Produce an error code if a resource is requested but unavailable

Example:

  set RetCode to OCI_oopt( Cursor, OCI_ROLLBACK_ROW, OCI_NOWAIT )