Update String

Convenience Function

Declaration

tibrv_status tibrvMsg_UpdateString(
   tibrvMsg     message,
   const char*  fieldName,
   const char*  value);
tibrv_status tibrvMsg_UpdateStringEx(
   tibrvMsg     message,
   const char*  fieldName,
   const char*  value,
   tibrv_u16    fieldId);

Purpose

Update a field containing a character string.

Remarks

This convenience function locates a field (by name or identifier) and updates its data.

The type of the existing field (within the message) and the type of the updating value must match. The length of the string can change.

Pointer data previously extracted from the field remain valid and unchanged until the message is destroyed; that is, even updating the field’s value does not invalidate pointer data. (See Pointer Snapshot.)

Parameter	Description
message	Update the specified field of this message.
fieldName	Update a field with this name.
value	Update the message field to this value (which may be a literal or stored in a variable). The function copies the new value into the existing field.
fieldId	Update the field with this identifier. Zero is a special value that signifies no field identifier. It is illegal to add a field that has both a NULL field name, and a non-zero field identifier.

See Also

Field Names and Field Identifiers