Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awGet | awGetField
 
awGetField
BrokerError awGetField( BrokerEvent event, char *field_name,
short *field_type, void **value);
event
The event containing the desired field.
field_name
Name of the desired event field.
field_type
The field's type, such as FIELD_TYPE_BOOLEAN, defined in <awetdef.h>. This parameter is used for output.
value
The value of the field. The type of this value depends on the field_type. This parameter is used for output.
Provides the value of the field specified by field_name. This is a generic access function.
See Specifying Field Names for complete information on specifying field_name.
The caller is responsible for freeing the return value in a manner appropriate to the field's type. For a struct type, call awDeleteEvent to free the value. To free all other values, simply call free.
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 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_type is FIELD_TYPE_SEQUENCE or is not a supported field type.
AW_ERROR_NULL_PARAM
The parameter field_name or value is NULL.
See also: