Update Nested Message

Convenience Function

Declaration

tibrv_status tibrvMsg_UpdateMsg(
   tibrvMsg     message,
   const char*  fieldName,
   tibrvMsg     value);
tibrv_status tibrvMsg_UpdateMsgEx(
   tibrvMsg     message,
   const char*  fieldName,
   tibrvMsg     value,
   tibrv_u16    fieldId);

Purpose

Update a field containing a nested submessage.

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 message size (that is, its length in bytes) can change.

This function uses only the data portion of the nested message (value); it does not include any address information or certified delivery information.

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.

The function copies the new value into the 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