Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awSet | awSet<type>SeqField
 
awSet<type>SeqField
The awSet<type>SeqField functions have a general syntax:
BrokerError awSet<type>SeqField(
BrokerEvent event,
char *field_name,
int src_offsetint dest_offset,
int n,
<Sequence_Value_Type> value_array);
event
The event whose sequence field is to be set.
field_name
Name of the destination event field.
src_offset
Elements to skip from the beginning of the source elements.
dest_offset
Elements to skip from the beginning of the sequence.
n
Number of source elements.
value_array
The source value array. The sequence value type is different depending on the function as follows
*awSetBooleanSeqField has a sequence value type of BrokerBoolean *.
*awSetByteSeqField has a sequence value type of char *.
*awSetCharSeqField has a sequence value type of char *.
*awSetDateSeqField has a sequence value type of BrokerDate *.
*awSetDoubleSeqField has a sequence value type of double *.
*awSetFloatSeqField has a sequence value type of float *.
*awSetIntegerSeqField has a sequence value type of int *.
*awSetLongSeqField has a sequence value type of BrokerLong *.
*awSetShortSeqField has a sequence value type of short *.
*awSetStringSeqField has a sequence value type of char **.
*awSetUCCharSeqField has a sequence value type of charUC *.
*awSetUCStringSeqField has a sequence value type of charUC **.
Each awSet<type>SeqField function sets the destination sequence field, field_name, contained in event to the sequence of values contained in value_array. To set a non-sequence field in an event, use one of the awSet<type>Field functions.
Each of the awSet<type>SeqField functions may overwrite all or part of the destination sequence field. These functions may also cause the destination sequence to grow, if a larger number of elements are stored into the sequence. These functions never reduce the number of elements in the destination sequence: You must use awSetSequenceFieldSize function to reduce the size of a sequence. 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. No error will be returned if awSetStringSeqField is used to set a field whose type is FIELD_TYPE_UNICODE_STRING. In these cases, the ANSI string that is supplied to awSetStringSeqField will automatically be converted to a unicode string.
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 value or the field_name incorrectly accesses a type.
AW_ERROR_INVALID_EVENT
The event is invalid.
AW_ERROR_INVALID_FIELD_NAME
The field_name is invalid.
AW_ERROR_NULL_PARAM
The parameter field_name or value is NULL.
AW_ERROR_OUT_OF_RANGE
The src_offset is out of range, the dest_offset is less than zero, or n is less than zero.
See also: