TipcMtGetName

Name

TipcMtGetName — get the name of a message type

Synopsis

T_BOOL TipcMtGetName(mt, name_return) 
T_IPC_MT mt; 
T_STR *name_return; 

Arguments

mt — message type to get name from

name_return — storage for message type name

Return Values

TRUE if the name was successfully retrieved from the message type, FALSE otherwise.

Diagnostics

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

Description

TipcMtGetName gets the name of a message type. Message type names are identifiers.

Caution

If TipcMtGetName returns FALSE, it does not store a value in name_return.

The value stored in name_return points directly into an internal data structure and should not be modified.

See Also

TipcMtCreate, TipcMtGetGrammar, TipcMtGetNum

Examples

This example prints the name of the NUMERIC_DATA message type:

T_IPC_MT mt; 
T_STR name; 
 
mt = TipcMtLookupByNum(T_MT_NUMERIC_DATA); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMtGetName(mt, &name)) { 
  return;  /* error */ 
}  
 
TutOut("NUMERIC_DATA msg type has name %s\n", name);