TipcMsgUpdateNamedXmlPtr

Name

TipcMsgUpdateNamedXmlPtr — update a pointer to the value of a named XML field in a message

Synopsis

T_BOOL TipcMsgUpdateNamedXmlPtr(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 append the field

name — name of the field

value — XML object to append to message

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

Return Values

TRUE if the append was successful, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg, name or value is null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_FT_MISMATCH — the message type grammar did not match the fields in the message

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

T_ERR_VALUE_INVALID — value was not a valid value

Description

TipcMsgUpdateNamedXmlPtr appends an XML object in a message, associating that field with a name. 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.

Examples

This example changes the value of the named field "data":

T_XML data; 
if (!TipcMsgUpdateNamedXmlPtr(msg, "data", data, T_NULL)) { 
  return;  /* error */ 
}