Chapter 15 Administration : tibemsCollection

tibemsCollection
Type
Purpose
Represent a collection of administrative objects.
Remarks
Collections provide an array-like set of administrative objects for use by the calling program. Administrative objects include tibemsQueueInfo, tibemsTopicInfo, tibemsConsumerInfo, tibemsProducerInfo, and tibemsDetailedDestStat objects.
 
See Also
tibemsAdmin_GetQueues on page 425
tibemsAdmin_GetTopics on page 428
tibemsAdmin_GetConsumers on page 418
tibemsAdmin_GetProducerStatistics on page 422
tibemsConsumerInfo_GetDetailedStatistics on page 445
tibemsProducerInfo_GetDetailedStatistics on page 467
tibemsCollection_Destroy
Function
Purpose
Destroy a collection.
C Declaration
tibems_status tibemsCollection_Destroy(
    tibemsCollection collection);
COBOL Call
CALL "tibemsCollection_Destroy"
 USING BY VALUE collection,
       RETURNING tibems-status
END-CALL.
collection has usage pointer.
Parameters
 
Remarks
Collections are created internally by the EMS library. Use tibemsCollection_Destroy to remove collections of tibemsQueueInfo, tibemsTopicInfo, tibemsConsumerInfo, and tibemsProducerInfo objects. Collections of tibemsDetailedDestStat objects cannot be directly destroyed by the user application. Attempting to destroy a tibemsDetailedDestStat object returns TIBEMS_NOT_PERMITTED.
Status Codes
 
tibemsCollection_GetCount
Function
Purpose
Get the count of objects in a collection.
C Declaration
tibems_status tibemsCollection_GetCount(
    tibemsCollection collection,
    tibems_int* count);
COBOL Call
CALL "tibemsCollection_GetCount"
 USING BY VALUE collection,
       BY REFERENCE count,
       RETURNING tibems-status
END-CALL.
collection has usage pointer.
Parameters
 
 
tibemsCollection_GetFirst
Function
Purpose
Get the first object in a collection.
C Declaration
tibems_status tibemsCollection_GetFirst(
    tibemsCollection collection,
    collectionObj* object);
COBOL Call
CALL "tibemsCollection_GetFirst"
 USING BY VALUE collection,
       BY REFERENCE obj,
       RETURNING tibems-status
END-CALL.
collection has usage pointer.
Parameters
 
Remarks
This function must be called before any calls to tibemsCollection_GetNext.
 
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.
 
collection has usage pointer.
Parameters
 
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
 
The collection has not been initialized with a call to tibemsCollection_GetFirst.