Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awNew | awNewSubscriptionFromStruct
 
awNewSubscriptionFromStruct
BrokerError awNewSubscriptionFromStruct(
BrokerClient client,
BrokerSubscription *sub);
client
The Broker client requesting the subscription.
sub
The subscription structure. See BrokerSubscription Objects for more information.
Subscribes the specified client to the events specified by the subscription structure sub. The subscription structure should be initialized with the desired subscription identifier, event name, and filter string.
If the subscription has already been registered, calling this function will have no effect. A subscription with a sub_id of 1 will not be replaced with a new subscription with a sub_id of 2 that otherwise is identical.
Possible BrokerError major codes
Meaning
AW_ERROR_INVALID_CLIENT
The client has been destroyed or disconnected.
AW_ERROR_INVALID_SUBSCRIPTION
The filter string contains a parse error.
AW_ERROR_NO_PERMISSION
The client does not have permission to subscribe to the event type.
AW_ERROR_NULL_PARAM
The sub parameter or the event type name it contains is NULL.
AW_ERROR_OUT_OF_RANGE
The subscription identifier contained in sub is less than zero.
AW_ERROR_UNKNOWN_EVENT_TYPE
The event type does not exist on the Broker.
See also: