tibemsCollection_GetNext

Function

Purpose

Get the next object in a collection.

C Declaration

tibems_status tibemsCollection_GetNext(
    tibemsCollection collection,
    collectionObj* object);

COBOL Call

CALL "tibemsCollection_GetNext"
 USING BY VALUE collection,
       BY REFERENCE obj,
       RETURNING tibems-status
END-CALL.
Note: collection has usage pointer.

Parameters

Parameter Description
collection Get the next object in this collection.
object The function stores the next object in the collection in this location.

Remarks

This function gets the next object in a collection. If there are no more objects in the collection, tibemsCollection_GetNext returns TIBEMS_NOT_FOUND.

The function tibemsCollection_GetFirst must be called before tibemsCollection_GetNext is called for the first time.

Status Codes

Status Code Description
TIBEMS_NOT_INITIALIZED The collection has not been initialized with a call to tibemsCollection_GetFirst.
TIBEMS_NOT_FOUND There are no more objects in the collection.