User-Defined Property


Type:
Four-byte integer of C type T_INT4
Default Value:
0
Valid Values:
Any integer 0 or greater

The user-defined property identifies the default user-defined property for messages of this type. The message user-defined property can be used for any purpose, such as attaching a version number to messages. When a message is created, its user-defined property is initialized to the message type user-defined property. Message user-defined properties are discussed in User-Defined Property.

The user-defined property of an outgoing message can always be set on a per-message basis, but using the message type user-defined property makes it easier to change the default user-defined property for all outgoing messages of a specific type. The standard SmartSockets message types by default all have a user-defined property of zero (0), but these may be changed if desired. User-defined message types can also use whatever user-defined property is appropriate.

Function to set value:

TipcMtSetUserProp. For example:

if (!TipcMtSetUserProp(mt, 42)) { 
  /* error */ 
} 
Function to get value:

TipcMtGetUserProp. For example:

if (!TipcMtGetUserProp(mt, &user_prop)) { 
  /* error */ 
} 

TIBCO SmartSockets™ User’s Guide
Software Release 6.8, July 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com