TipcMsgAppendXml

Name

TipcMsgAppendXml — append an XML field to a message

Synopsis

T_BOOL TipcMsgAppendXml(msg, xml_data) 
T_IPC_MSG msg; 
T_XML xml_data;

Arguments

msg — message to which to append the field

xml_data — data for new message field

Return Values

TRUE if the field was successfully appended to the message, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg was null or xml_data was null

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

T_ERR_MSG_INVALID — msg was not a valid message

Description

TipcMsgAppendXml appends an XML object field to the end of a message’s data. TipcMsgAppendXml makes a copy of the XML object.

Caution

None

Examples

This example creates a message and appends an XML field:

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_XML xml; 
 
T_XML xml_val; 
#define USER_MT_XML_TEST 100 
mt = TipcMtCreate("xml_test", USER_MT_XML_TEST, "xml"); 
if (mt == NULL) { 
return;  /* error */ 
} 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
return;  /* error */ 
} 
xml = TutXmlCreate(“<data><data1><temp=\”hot\”/></data1></data>”); 
if (xml == NULL) { 
  return;  /* error */ 
} 
if (!TipcMsgAppendXml(msg, xml)) { 
return;  /* error */ 
}