OCI_GetArrayAsStreamShelf

function

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

Declaration

define external function OCI_GetArrayAsStreamShelf
   (  value OCI_Array_type Array,
      modifiable stream ReturnedShelf,
      value integer ElementCount
   )

Purpose

This function retrieves elements from the OCI_Array_type variables data contents into the stream variable as shelf items.

Input arguments:

Array -- The OCI_Array_type variable to examine or manipulate.
ElementCount -- The total number of elements, starting from the first, to copy to the stream shelf. This must not exceed the declared element count of Array or an exception will be raised and the program will terminate.

Output argument:

ReturnedShelf -- The integer shelf into which the data is retrieved. This shelf must not be declared as variable. The shelf is cleared before data is inserted.