TipcMsgGetSenderTimestamp

Name

TipcMsgGetSenderTimestamp — get the sender timestamp property of a message

Synopsis

T_BOOL TipcMsgGetSenderTimestamp(msg, sender_timestamp_return) 
T_IPC_MSG msg; 
T_REAL8 *sender_timestamp_return; 

Arguments

msg — message to get sender timestamp from

sender_timestamp_return — storage for message sender timestamp

Return Values

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

Diagnostics

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

Description

TipcMsgGetSenderTimestamp gets the sender timestamp property of a message. A value of 0.0 indicates that the sender timestamp property was not set.

Caution

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

See Also

TipcMsgSetSenderTimestamp

Examples

This example gets the sender timestamp of a message:

T_REAL8 sender_timestamp; 
if (!TipcMsgGetSenderTimestamp(msg, &sender_timestamp)) { 
  return;  /* error */ 
}