Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awGet | awGetTypeDefFieldNames
 
awGetTypeDefFieldNames
BrokerError awGetTypeDefFieldNames(
BrokerTypeDef type_def,
char *field_name,
int *n,
char ***names);
type_def
The event type definition.
field_name
The name of a structure field whose sub-fields are to be obtained. If set to NULL, the fields at the top level of the event are obtained.
n
The number of field names returned in names. This parameter is used for output.
names
An array of event type definitions. This parameter is used for output.
Obtains an array of strings that represents the field names of the specified event type or field. In addition, n is set to the number of strings returned in names.
See Specifying Field Names for complete information on specifying field_name.
The caller is responsible for calling free on names. All of the strings in names share one memory block so multiple calls to free are not necessary.
Possible BrokerError major codes
Meaning
AW_ERROR_FIELD_NOT_FOUND
The field_name does not exist in the event type.
AW_ERROR_FIELD_TYPE_MISMATCH
The field_name incorrectly accesses a type, such as using a subscript on a non-sequence field.
AW_ERROR_INVALID_FIELD_NAME
The field_name is invalid.
AW_ERROR_INVALID_TYPEDEF
The type_def parameter is invalid.
AW_ERROR_NULL_PARAM
The field_name, n, or names parameter is NULL.