awGetScopeEventTypeNames
BrokerError awGetScopeEventTypeNames(
BrokerClient client,
char *scope_name,
int *n,
char ***event_type_names);
client | The Broker client requesting the event names. |
scope_name | The scope of the events to be obtained. |
n | The number of strings in names. This parameter is used for output. |
event_type_names | An array of strings containing the event type names. This parameter is used for output. |
Provides the names of event types for this Broker client in the specified event scope. The names, which are fully qualified, are returned as an array of strings.
Note:
Only the names of the event types which your client is permitted to browse are returned. In most cases, this corresponds to the set of event types which your client can publish or for which it can register subscriptions.
The caller is responsible for calling free on event_type_names. The strings contained in event_type_names share one memory block so multiple calls to free are not necessary.
Possible BrokerError major codes | Meaning |
AW_ERROR_INVALID_CLIENT | The client has been destroyed or disconnected. |
AW_ERROR_NULL_PARAM | The parameter scope_name, n, or event_type_names is NULL. |
AW_ERROR_UNKNOWN_EVENT_TYPE | The scope_name does not exist on the Broker. |
See also: