TipcMsgSetReplyTo

Name

TipcMsgSetReplyTo — set the reply to destination property of a message

Synopsis

T_BOOL TipcMsgSetReplyTo(msg, reply_to_dest) 
T_IPC_MSG msg; 
T_STR reply_to_dest;

Arguments

msg — message to set reply to destination for

reply_to_dest — message reply to destination

Return Values

TRUE if the reply to destination was successfully set for the message, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg was null or reply_to_dest 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.

T_ERR_VAL_INVALID — reply_to_dest was not a valid subject

Description

TipcMsgSetReplyTo sets the reply to destination property of a message. The reply to destination property is a string representing a subject where a reply to the message should be sent.

Caution

TipcMsgSetReplyTo does not detect errors in reply_to_dest, such as misspelled subject names.

Examples

This example sets the reply to destination property of a message to reply_subject:

if (!TipcMsgSetReplyTo(msg, "reply_subject")) { 
  return;  /* error */ 
}