TipcMsgGetNamedXml

Name

TipcMsgGetNamedXml — Get a named XML field from a message

Synopsis

T_BOOL TipcMsgGetNamedXml(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_XML *xml_return;

Arguments

msg — message to get field from

name — name of the field

xml_return — return pointer to value of the field

Return Values

TRUE if the get was successful, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg was null or xml_return was null.

T_ERR_MSG_INVALID — msg was not a valid message.

T_ERR_MSG_EOM — the current field is at the end of message.

T_ERR_FT_MISMATCH — the current field is of the wrong type.

T_ERR_VAL_UNKNOWN — the current field is of unknown value.

Description

TipcMsgGetNamedXml gets the field specified by the name. If no field by this name exists, or the field associated with this name is unknown, this function fails.

Caution

If TipcMsgGetNamedXml returns FALSE, it does not store a value in xml_return.

Do not modify the value stored in xml_return. It points directly into an internal data structure.

Examples

T_IPC_MSG msg; 
T_BOOL status; 
T_XML xml; 
 
status = TipcMsgGetNamedXml(msg, "foo", &xml); 
if (status == FALSE) { 
return;  /* error */ 
}