TipcMsgAddNamedXml

Name

TipcMsgAddNamedXml — Add a named XML field to a message

Synopsis

T_BOOL TipcMsgAddNamedXml(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_XML value; 

Arguments

msg — message to which to add the field

name — name of the field

value — value of the field

Return Values

TRUE if the addition was successful, FALSE otherwise.

Diagnostics

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

Description

TipcMsgAddNamedXml adds an XML object 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

TipcMsgAppendXml, TipcMsgUpdateNamedXml, TipcMsgGetNamedXml

Examples

T_IPC_MSG msg; 
T_XML xml; 
T_BOOL status; 
msg = TipcMsgCreate(TipcMtLookupByNum(T_MT_INFO)); 
if (msg == NULL) { 
  return;  /* error */ 
} 
xml = TutXmlCreate(“<data><data1><temp=\”hot\”/></data1></data>”); 
if (xml == NULL) { 
  return;  /* error */ 
} 
status = TipcMsgAddNamedXml(msg, "foo", xml); 
if (status == FALSE) { 
return;  /* error */