Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awGet | awGetUCStringFieldAsUTF8
 
awGetUCStringFieldAsUTF8
BrokerError awGetUCStringFieldAsUTF8(
BrokerEvent event,
char *field_name,
charUC **value);
event
The event from which the string is to be retrieved.
field_name
The name of the string field to be retrieved.
value
The string that was retrieved. This parameter is used for output.
Obtains a Unicode string field with the specified field_name from the specified event. The string returned in value will be in Unicode Transform Function 8 (UTF-8) format, which encodes 16-bit Unicode characters in multi-byte, 8-bit encoding. This means that the string returned in value may contain as many as four logical characters for each Unicode character.
The caller is not responsible for freeing the return value.
Possible BrokerError major codes
Meaning
AW_ERROR_FIELD_NOT_FOUND
The field_name does not exist in the event type or an attempt was made to obtain the value of an envelope field that has not been set.
AW_ERROR_FIELD_TYPE_MISMATCH
The field_name incorrectly accesses a type, such as using a subscript on a non-sequence field.
AW_ERROR_INVALID_EVENT
The event is invalid.
AW_ERROR_INVALID_FIELD_NAME
The field_name is invalid.
AW_ERROR_NULL_PARAM
The field_name or value parameter is NULL.
See also: