TipcMsgUpdateNamedUtf8

Name

TipcMsgUpdateNamedUtf8 — update a named UTF8 field in a message with new data

Synopsis

T_BOOL TipcMsgUpdateNamedUtf8(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_STR value; 

Arguments

msg — message to update field in

name — name of the field

value — new value of the field

Return Values

TRUE if the update was successful, FALSE otherwise.

Diagnostics

If TipcMsgUpdateNamedUtf8 fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — msg, name or value is null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_FT_MISMATCH — the message type grammar did not match the fields in the message

T_ERR_READ_ONLY — msg was marked read-only. This happens if the message is a field in another message.

T_ERR_VALUE_INVALID — value was not a valid value

Description

TipcMsgUpdateNamedUtf8 updates a UTF8 field specified by field name.

See Also

TipcMsgAddNamedUtf8, TipcMsgGetNamedUtf8

Examples

This example changes the value of the named field "data":

T_STR data; 
if (!TipcMsgUpdateNamedUtf8(msg, "data", data)) { 
  return;  /* error */ 
}