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.
Note: collection has usage pointer.

Parameters

Parameter Description
collection The collection object to be destroyed.

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

Status Code Description
TIBEMS_NOT_PERMITTED The collection may not be directly destroyed by the application.