Broker 10.15 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awSet | awSetUCStringFieldToSubstring
 
awSetUCStringFieldToSubstring
BrokerError awSetUCStringFieldToSubstring(
BrokerEvent event,
char *field_name,
int char_offset,
int nc,
char *value);
event
The event whose string field is to be set.
field_name
Name of the string field.
char_offset
Character offset from beginning of field.
nc
Number of characters to use. If set to -1, the rest of the string will be used.
value
The new value for the string field.
Sets the value of the Unicode string field field_name to the specified sub-string value. The number of characters to be set is specified by nc. The offset into the field is specified by char_offset.
See Specifying Field Names for complete information on specifying field_name.
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 is not a string 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 char_offset is out of range, the dest_offset is less than zero, or nc is less than -1.
See also: