TipcMtSetUserProp

Name

TipcMtSetUserProp — set the user-defined property of a message type

Synopsis

T_BOOL TipcMtSetUserProp(mt, user_prop) 
T_IPC_MT mt; 
T_INT4 user_prop; 

Arguments

mt — message type to set user-defined property for

user_prop — message type user-defined property

Return Values

TRUE if the user-defined property was successfully set for the message type, FALSE otherwise.

Diagnostics

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

Description

TipcMtSetUserProp sets the user-defined property of a message type. The user-defined property of a message type is used as the default user-defined property for messages of this type. See TipcMtGetUserProp for more information on message type user-defined properties.

Caution

None

See Also

TipcMsgSetUserProp, TipcMtGetUserProp

Examples

This example sets the user-defined property of the NUMERIC_DATA message type to 42:

T_IPC_MT mt; 
 
mt = TipcMtLookup("numeric_data"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
if (!TipcMtSetUserProp(mt, 42)) { 
  return;  /* error */ 
} 
 
/* After this point, all newly-created NUMERIC_DATA messages will have a default user-defined 
property of 42. */