awGetSequenceField

awGetSequenceField

BrokerError awGetSequenceField(
BrokerEvent event,
char *field_name,
int offset,
int max_n,
short *field_type,
int *n,
void **value);

event	The event whose sequence field is to be obtained.
field_name	The name of the sequence-type event field.
offset	Number of elements to skip from the beginning of the sequence.
max_n	Number of elements requested this call. If set to -1, all elements will be obtained.
field_type	The type of the fields in the sequence, such as FIELD_TYPE_BOOLEAN, defined in <awetdef.h>. This parameter is used for output.
n	Number of elements returned. This parameter is used for output.
value	The array of pointers to the values. This parameter is used for output.

Provides the values of the sequence field specified by field_name. This is a generic access function. The caller is responsible for appropriately freeing the returned values, based on their type.

If you get a sequence field whose value was not set by the event's publisher, a zero-length sequence will be returned.

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.

Possible BrokerError major codes	Meaning
AW_ERROR_FIELD_NOT_FOUND	The field_name does not exist in the event 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'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_INVALID_TYPE	The field is a sequence of sequences and cannot be retrieved with this function.
AW_ERROR_NULL_PARAM	The parameter field_name, n, field_type, or value is NULL.
AW_ERROR_OUT_OF_RANGE	The offset is less than zero or greater that the sequence size, or max_n is less than zero.