Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awGet | awGetUCStringSeqFieldAsUTF8
 
awGetUCStringSeqFieldAsUTF8
BrokerError awGetUCStringSeqFieldAsUTF8(
BrokerEvent event,
char *field_name,
int offset,
int max_n,
int *n,
charUC ***value);
event
The event from which the string sequence is to be retrieved.
field_name
The name of the sequence field to be retrieved.
offset
The number of elements to skip from the beginning of the sequence.
max_n
The number of elements requested. If set to -1, all elements are requested.
n
The number of elements actually returned. This parameter is used for output.
value
An array of values associated with the field. This parameter is used for output.
Obtains a Unicode string sequence field with the specified field_name from the specified event. The array of values returned 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 each string returned may contain as many as four logical characters for each Unicode character.
See Specifying Field Names for complete information on specifying field_name.
For information on how to use offset, max_n, and value; see awGet<type>SeqField.
The caller is not responsible for freeing the return value.
Possible BrokerError major codes
Meaning
AW_ERROR_INVALID_EVENT
The event is invalid.
AW_ERROR_INVALID_TYPEDEF
The event is not associated with a Broker client.
AW_ERROR_NULL_PARAM
The parameter type_def is NULL.
See also: