awGetFieldNames

awGetFieldNames

BrokerError awGetFieldNames(
BrokerEvent event,
char *field_name,
int *n,
char ***field_names);

event	The event whose field names are to be returned.
field_name	The field name of a structure containing other fields. If set to NULL, all of the fields in the event are returned.
n	Number of names returned in field_names. This parameter is used for output.
field_names	The array of field names returned. This parameter is used for output.

Provides field names of data fields of the specified event. If field_name is NULL awGetFieldNames gets the fields of the event itself. Otherwise, field_name should refer to a field in a structure and this function returns all of the field names at that level.

Note that field_name can directly identify any field in the event, no matter how deeply nested the fields may be. See Getting Sequence Field Values and Specifying Field Names for complete information on specifying field_name.

The caller is responsible for calling free on the output value. The strings in field_names share one memory block so multiple calls to free are not necessary.

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, n, or field_names is NULL.