TipcMsgGetNamedStr

TipcMsgGetNamedStr — get a field with a STR value from a message, using a name

T_BOOL TipcMsgGetNamedStr(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value_return;

msg — message to get field from

name — name of the field

value_return — return pointer to value of the field

TRUE if the get was successful, FALSE otherwise.

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

T_ERR_NULL_PTR — msg was null or name was null

T_ERR_MSG_INVALID — msg was not a valid message

TipcMsgGetNamedStr gets the field specified by the name. The function fails if:

No field by this name exists.

The field associated with this name is not a STR field.

The field associated with this name is unknown. See the TIBCO SmartSockets User’s Guide for more information on unknown field values.

If TipcMsgGetNamedStr returns FALSE, it does not store a value in value_return.

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

This example gets a STR field from an existing message:

T_IPC_MSG msg; 
T_BOOL status; 
T_STR value; 
 
status = TipcMsgGetNamedStr(msg, "foo", &value); 
if (status == FALSE) { 
  return;  /* error */ 
}