OCI_oexfet

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_oexfet
   (  value OCI_Handle_type cursor,
      value integer nrows,
      value integer cancel,
      value integer exact
   )

Purpose

This function executes the SQL statement associated with a cursor, then fetches one or more rows. This function can also cancel the cursor.

Input arguments:

cursor -- Cursor data area descriptor.
nrows -- The number of rows to fetch.
cancel -- If this parameter is non-zero, the cursor is canceled after the fetch completes. The following values are allowed:
- OCI_CANCEL -- The cursor is canceled after the fetch completes.
- OCI_NOCANCEL -- The cursor is not canceled.
exact -- If this parameter is non-zero, an error is returned if the number of rows that satisfy the query is not exactly the same as the nrows value. Nevertheless, the rows are returned. The following values are allowed:
- OCI_EXACT -- Raises an error if fewer than the requested rows are fetched.
- OCI_NOEXACT -- No error is raised.

Example:

  set RetCode to OCI_oexfet
     (  Cursor, 
        1,  
        OCI_NOCANCEL,
        OCI_NOEXACT
     )