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_osetpi
   (  value OCI_Handle_type cursor,
      value integer piece,
      value OCI_Array_type bufp,
      value OCI_Array_type lenp
   )

This function sets information about the next chunk of data to be processed as part of a piecewise insert, update, or fetch.

Input arguments:

• cursor -- Cursor data area descriptor.
• piece -- Specifies the piece being provided or fetched. The following values are allowed:
  • OCI_FIRST_PIECE -- the first of many pieces
  • OCI_NEXT_PIECE -- the next of many pieces
  • OCI_LAST_PIECE -- the last piece of this column
• bufp -- The data buffer that contains the data to be inserted or retrieved.
• lenp -- Length, in bytes, of the current piece.

Example:

  set RetCode to OCI_osetpi
           (  Cursor,
              Piece,
              NextChunk,
              ChunkSize
           )

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 ]