TipcMsgAddNamedStr

Name

TipcMsgAddNamedStr — add a STR field to a message using a name

Synopsis

T_BOOL TipcMsgAddNamedStr(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 TipcMsgAddNamedStr fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcMsgAddNamedStr adds a string 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

TipcMsgAppendStr, TipcMsgUpdateNamedStr, TipcMsgGetNamedStr

Examples

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

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