Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 15 Administration : tibemsAdmin : tibemsAdmin_GetSubscriptions

tibemsAdmin_GetSubscriptions
Function
Purpose
Return subscriptions matching the specified filters.
C Declaration
tibems_status tibemsAdmin_GetSubscriptions(
    tibemsAdmin admin,
    tibemsCollection* collection,
    tibems_int filterFlags,
    const char* name,
    const char* topicName);
COBOL Call
CALL "tibemsAdmin_GetSubscriptions"
 USING BY VALUE admin,
       BY REFERENCE collection,
       BY VALUE filterFlags,
       BY REFERENCE name,
       BY REFERENCE topicName,
       RETURNING tibems-status
END-CALL.
collection has usage pointer.
Parameters
 
Remarks
Returns a list of all subscriptions that match the specified filters. The subscriptions are returned in a tibemsCollection; if no subscription matching the filter criteria exist in the server, then no tibemsCollection is returned.
The returned subscriptions are not sorted and are placed in the tibemsCollection object in any order. Your application may need to sort the subscriptions into a specific order.
For example, the following returns all shared subscriptions known to the server:
tibemsAdmin admin;
tibemsCollection subscriptionsInfo;
tibems_status status;
status = tibemsAdim_GetSubscriptions(admin, &subscriptionsInfo, 0, NULL, NULL);
The following returns all durable (shared or not shared) subscriptions known to the server:
tibemsAdmin admin;
tibemsCollection subscriptionsInfo;
tibems_status status;
status = tibemsAdim_GetSubscriptions(admin, &subscriptionsInfo, TIBEMS_SUBSCRIPTIONS_FILTER_DURABLE_ONLY, NULL, NULL);
The following returns all shared durable subscriptions on any topic matching topic news.*:
tibemsAdmin admin;
tibemsCollection subscriptionsInfo;
tibems_status status;
status = tibemsAdim_GetSubscriptions(admin, &subscriptionsInfo, TIBEMS_SUBSCRIPTIONS_FILTER_DURABLE_ONLY + TIBEMS_SUBSCRIPTIONS_FILTER_SHARED_ONLY, NULL, "news.*");
Status Codes
 
 

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved