TipcMsgGetNamedUnknown

Name

TipcMsgGetNamedUnknown — get a field with an unknown or non-existent value from a message, using a name

Synopsis

T_BOOL TipcMsgGetNamedUnknown(msg, name) 
T_IPC_MSG msg; 
T_STR name; 

Arguments

msg — message to get field from

name — name of the field

Return Values

TRUE if the get was successful, FALSE otherwise.

Diagnostics

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

Description

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

Caution

None

See Also

TipcMsgAppendUnknown, TipcMsgUpdateNamedUnknown, TipcMsgNextUnknown

Examples

This example gets a named field of unknown type from an existing message:

T_IPC_MSG msg; 
T_BOOL status; 
 
status = TipcMsgGetNamedUnknown(msg, "foo"); 
if (status == FALSE) { 
  return;  /* error */ 
}