TipcMsgAddNamedUtf8

Name

TipcMsgAddNamedUtf8 — add a UTF8 field to a message using a name

Synopsis

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

Arguments

msg — message to add field to

name — name of the field

value — value of the field

Return Values

TRUE if the addition was successful, FALSE otherwise.

Diagnostics

If TipcMsgAddNamedUtf8 fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcMsgAddNamedUtf8 adds a UTF8 field to a message, associating that field with a name. If the name already exists in the message, this fails, and the field is not added to the message.

See Also

TipcMsgAppendUtf8, TipcMsgUpdateNamedUtf8, TipcMsgGetNamedUtf8

Examples

This example creates a message and adds a UTF8 value to it:

T_IPC_MSG msg; 
T_BOOL status; 
 
msg = TipcMsgCreate(TipcMtLookupByNum(T_MT_INFO)); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
status = TipcMsgAddNamedUtf8(msg, "foo", "bar"); 
if (status == FALSE) { 
  return;  /* error */ 
}