TipcMsgGetCorrelationId

Name

TipcMsgGetCorrelationId — get the correlation identifier property of a message

Synopsis

T_BOOL TipcMsgGetCorrelationId(msg, correlation_id_return) 
T_IPC_MSG msg; 
T_STR *correlation_id_return; 

Arguments

msg — message to get identifier from

correlation_id_return — storage for identifier

Return Values

TRUE if the identifier was successfully retrieved from the message, FALSE otherwise.

Diagnostics

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

Description

TipcMsgGetCorrelationId gets the correlation identifier property of a message. The 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

If TipcMsgGetCorrelationId returns FALSE, it does not store a value in correlation_id_return.

Do not modify the value stored in correlation_id_return. It points directly into an internal data structure.

See Also

TipcMsgSetCorrelationId, TipcMsgGenerateMessageId, TipcMsgGetMessageId

Examples

This example prints the correlation identifier of a message:

T_STR id; 
if (!TipcMsgGetCorrelationId(msg, &id)) { 
  return;  /* error */ 
} 
TutOut("msg had identifier %s\n", id ? id : "<NULL>");