TipcMsgSetCorrelationId

Name

TipcMsgSetCorrelationId — set the correlation identifier property of a message

Synopsis

T_BOOL TipcMsgSetCorrelationId(msg, correlation_id) 
T_IPC_MSG msg; 
T_STR correlation_id;

Arguments

msg — message to generate identifier for

correlation_id — message correlation identifier

Return Values

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

Diagnostics

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

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

TipcMsgSetCorrelationId sets the correlation identifier property of a message. The correlation identifier property is a string whose meaning depends on how the message is being used. Applications of messages are free to use the correlation identifier for any purpose.

Caution

None

Examples

This example sets the correlation identifier property of a message to the message identifier property of another message:

T_STR id; 
if (!TipcMsgGetMessageId(request_msg, &id)) { 
  return;  /* error */ 
} 
if (!TipcMsgSetCorrelationId(reply_msg, id)) { 
  return;  /* error */ 
}