|Oracle Call Interface Programmer's Guide
Release 2 (9.2)
Part Number A96584-01
OCI Datatype Mapping and Manipulation Functions, 8 of 134
Gets the current size in number of elements of the given 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 whose number of elements is returned. Must point to a valid collection descriptor.
Current number of elements in the collection.
Returns the current number of elements in the given collection. For the case of nested table, this count will not be decremented upon deleting elements. So, this count includes any holes created by deleting elements. A trim operation (
OCICollTrim()) will decrement the count by the number of trimmed elements. To get the count minus the deleted elements use
The following pseudocode shows some examples:
OCICollSize(...); // assume 'size' returned is equal to 5 OCITableDelete(...); // delete one element OCICollSize(...); // 'size' returned is still 5
To get the count minus the deleted elements use
OCITableSize(). Continuing the above example:
A trim operation (
OCICollTrim()) decrements the count by the number of trimmed elements. Continuing the above example:
This function returns an error if an error occurs during the loading of the collection into object cache or if any of the input parameters is null.