TipcMsgAddNamedXmlPtr

Name

TipcMsgAddNamedXmlPtr — Add a named XML pointer field to a message

Synopsis

T_BOOL TipcMsgAddNamedXmlPtr(msg, name, value, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_XML value; 
T_IPC_MSG_FIELD *field_return; 

Arguments

msg — message to which to add the field

name — name of the field

value — XML object to add to message

field_return — optional value to return field (use NULL if not needed)

Return Values

TRUE if the addition was successful, FALSE otherwise.

Diagnostics

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

Description

TipcMsgAddNamedXmlPtr 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. The value given is used as a pointer to the value, so the copy is made when the message is actually sent, not when the call is made. You must ensure that the data pointed to remains valid until the message is sent.

See Also

TipcMsgAppendXmlPtr, TipcMsgUpdateNamedXmlPtr, TipcMsgFieldUpdateXmlPtr

Examples

T_IPC_MSG msg; 
T_XML xml; 
T_BOOL status; 
T_IPC_MSG_FIELD *field_return; 
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 = TipcMsgAddNamedXmlPtr(msg, "foo", xml, field_return); 
if (status == FALSE) { 
return;  /* error */