TipcMsgAddNamedMsg

Name

TipcMsgAddNamedMsg — add a MSG field to a message using a name

Synopsis

T_BOOL TipcMsgAddNamedMsg(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG 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 TipcMsgAddNamedMsg fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcMsgAddNamedMsg adds a MSG 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

TipcMsgAppendMsg, TipcMsgUpdateNamedMsg, TipcMsgGetNamedMsg

Examples

This example creates a message and adds a MSG field to it:

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