|Oracle Call Interface Programmer's Guide
Release 2 (9.2)
Part Number A96584-01
OCI Datatype Mapping and Manipulation Functions, 10 of 134
Creates an iterator to scan the elements or the collection.
The OCI environment handle initialized in object mode.
The OCI error handle. If there is an error, it is recorded in
err and this function returns OCI_ERROR. Obtain diagnostic information by calling
Collection which will be scanned. For this release, valid collection types include varrays and nested tables.
Address to the allocated collection iterator is returned by this function.
The iterator is created in the object cache. The iterator is initialized to point to the beginning of the collection.
OCIIterNext() is called immediately after creating the iterator then the first element of the collection is returned. If
OCIIterPrev() is called immediately after creating the iterator then a "at beginning of collection" error is returned.
This function returns an error if any of the input parameters is null.