awGetEventTag
BrokerError awGetEventTag(
BrokerEvent event,
int *tag);
event | The event whose tag field is to be obtained. |
tag | The tag field that is obtained. This parameter is used for output. |
Obtains the tag envelope field from event and places it in tag. This is equivalent to, but more convenient than, calling:
awGetIntegerField(event,"_env.tag",&tag)
Returns an error if the event is invalid, or if the tag field is NULL, or if the _env.tag field does not exist.
Possible BrokerError major codes | Meaning |
AW_ERROR_FIELD_NOT_FOUND | The field _env.tag is not set on the event. |
AW_ERROR_INVALID_EVENT | The event is invalid. |
AW_ERROR_NULL_PARAM | The parameter tag is NULL. |
See also: