TipcMsgSetUserProp

Name

TipcMsgSetUserProp — set the user-defined property of a message

Synopsis

T_BOOL TipcMsgSetUserProp(msg, user_prop) 
T_IPC_MSG msg; 
T_INT4 user_prop;

Arguments

msg — message to set user-defined property for

user_prop — message user-defined property

Return Values

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

Diagnostics

If TipcMsgSetUserProp fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — msg was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_READ_ONLY — the message was marked read-only. This happens if the message is a field in another message.

Description

TipcMsgSetUserProp sets the user-defined property of a message. You can use the user-defined property for any purpose, such as attaching a version number to messages. TipcMsgSetUserProp overwrites the default value of the user-defined property set by TipcMtSetUserProp. See TipcMsgGetUserProp for more information on message user-defined properties.

Caution

None

Examples

This example sets the user-defined property of a message to 2:

if (!TipcMsgSetUserProp(msg, 2)) { 
  return;  /* error */ 
}