TipcMsgGenerateMessageId

Name

TipcMsgGenerateMessageId — generate the message identifier property for the message

Synopsis

T_BOOL TipcMsgGenerateMessageId(msg) 
T_IPC_MSG msg;

Arguments

msg — message to generate identifier for

Return Values

TRUE if the identifier was successfully set for the message, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — message was null

T_ERR_MSG_INVALID — message was not a valid message

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

Description

TipcMsgGenerateMessageId generates the unique message identifier property for the message. Applications of messages are free to use the message identifier for any purpose.

This message identifier is unique for all messages that are created anywhere. It is sent along with the message and adds 38 extra bytes to the message.

Caution

None

Examples

This example generates a message identifier:

if (!TipcMsgGenerateMessageId(msg)) { 
  return;  /* error */ 
}