Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awSet | awSetUCStringFieldAsUTF8
 
awSetUCStringFieldAsUTF8
BrokerError awSetUCStringFieldAsUTF8(
BrokerEvent event,
char *field_name,
char *utf8_value);
event
The event whose field is to be set.
field_name
Name of the destination event field to set.
value
The source value for the field. The value's type varies from function to function.
Sets the specified event field using the utf8_value, which contains a string in Unicode Transform Function 8 (UTF-8) format. UTF-8 format allows 16-bit Unicode characters to be represented as a sequence of up to four 8-bit encoded characters.
See Specifying Field Names for complete information on specifying field_name.
Note:
Attempting to set an event field with a type that does not match the event's definition will result in an error being returned.
Possible BrokerError major codes
Meaning
AW_ERROR_FIELD_NOT_FOUND
The event is associated with a Broker client and field_name does not exist in the event.
AW_ERROR_FIELD_TYPE_MISMATCH
The field's type does not match the type of utf8_value or 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 utf8_value is NULL.
See also: