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

Return type: Integer 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
   )

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
     )

Other Library Functions OCI_Array_type OCI_GetArrayAsCounter OCI_GetArrayAsCounterShelf OCI_GetArrayAsStream OCI_GetArrayAsStreamShelf OCI_GetArrayAsString OCI_GetArrayElementCount OCI_GetArrayElementLen OCI_GetErrorCode OCI_Handle_type OCI_HostData_type OCI_IsVersionCompatible OCI_LibraryVersion OCI_obindps OCI_obndra OCI_obndrn OCI_obndrv OCI_ocan OCI_oclose OCI_ocof OCI_ocom OCI_ocon OCI_odefin OCI_odefinps OCI_odescr OCI_odessp OCI_oerhms OCI_oexec OCI_oexfet OCI_oexn OCI_ofen OCI_ofetch OCI_oflng OCI_ogetpi OCI_olog OCI_ologof OCI_onbclr OCI_onbset OCI_onbtst OCI_oopen OCI_oopt OCI_oparse OCI_orol OCI_osetpi OCI_SetArrayAsCounter OCI_SetArrayAsCounterShelf OCI_SetArrayAsStream OCI_SetArrayAsStreamShelf OCI_SetArrayAsString OCI_SetArraySize

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]