OCI_ogetpi

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_ogetpi
   (  value OCI_Handle_type cursor,
      modifiable integer piecep,
      modifiable stream ctxpp,
      modifiable integer iterp,
      modifiable integer indexp
   )

Purpose

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

Input argument:

cursor -- Cursor data area descriptor.

Output arguments:

piecep -- Specifies if the piece is the first, intermediate, or last. 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.
ctxpp -- User-defined contextual data.
iterp -- The current iteration, starting at zero.
indexp -- The current index of an array mapped to a PL/SQL table, if an array is bound for an insert. This value varies between zero and the value set in the cursiz parameter of the obindps function.

Example:

   set RetCode to OCI_ogetpi
           (  Cursor,
              Piece,
              ContextValue,
              Iteration,
              Indexp
           )