TipcMsgGetNamedInt2

TipcMsgGetNamedInt2 — get a field with an INT2 value from a message, using a name

T_BOOL TipcMsgGetNamedInt2(msg, name, value_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 *value_return;

msg — message to get field from

name — name of the field

value_return — pointer to value of the field

TRUE if the get was successful, FALSE otherwise.

If TipcMsgGetNamedInt2 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

TipcMsgGetNamedInt2 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 an INT2 field.

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

If TipcMsgGetNamedInt2 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 an INT2 field from an existing message:

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