[TIBCO.EMS .NET Admin client library 8.1 documentation]
Assembly: TIBCO.EMS.ADMIN (in TIBCO.EMS.ADMIN.dll)
Returns subscriptions matching specified filters.
Namespace:
TIBCO.EMS.ADMINAssembly: TIBCO.EMS.ADMIN (in TIBCO.EMS.ADMIN.dll)
Syntax
public SubscriptionInfo[] GetSubscriptions( int filterFlags, string name, string topicName ) |
Public Function GetSubscriptions ( _ filterFlags As Integer, _ name As String, _ topicName As String _ ) As SubscriptionInfo() |
public: array<SubscriptionInfo^>^ GetSubscriptions( int filterFlags, String^ name, String^ topicName ) |
Parameters
- filterFlags
- Type: System..::.Int32
value can be any combination of SUBSCRIPTIONS_FILTER_DURABLE_ONLY, SUBSCRIPTIONS_FILTER_NO_DURABLE, SUBSCRIPTIONS_FILTER_SHARED_ONLY and SUBSCRIPTIONS_FILTER_NO_SHARED.
- name
- Type: System..::.String
specifies that only subscriptions with this name should be returned.
- topicName
- Type: System..::.String
specifies that only subscriptions on a topic matching this topic name should be returned.
Return Value
Array of subscriptions or array of 0 length.
Remarks
Returned array may be of 0 length if there is no subscription in the server which match specified filters.
This method returns only subscriptions matching filters specified by parameters filterFlags, name and topicName.
Filters may be omitted by specifying 0 or null value.
Returned subscriptions are not sorted and placed in the array in any order. Application may need to sort the subscriptions in application-specific order if required.
Examples
- Calling GetSubscriptions(0, null, null); returns all subscriptions known to server.
- Calling GetSubscriptions(Admin.SUBSCRIPTIONS_FILTER_DURABLE_ONLY, null, null); returns all durable (shared or not shared) subscriptions.
- Calling GetSubscriptions(Admin.SUBSCRIPTIONS_FILTER_DURABLE_ONLY + Admin.SUBSCRIPTIONS_FILTER_SHARED_ONLY, null, "news.*"); returns all shared durable subscriptions on any topic matching topic "news.*".
Exceptions
Exception | Condition |
---|---|
System..::.ArgumentException | if parameter filterFlags is invalid. |
TIBCO.EMS.ADMIN..::.AdminException | if not authorized or an error occurred. |