TipcMsgNextTimestamp

T_BOOL TipcMsgNextTimestamp(msg, timestamp_return) 
T_IPC_MSG msg; 
T_REAL8 *timestamp_return;

Arguments

Return Values

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

Diagnostics

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

T_ERR_NULL_PTR — msg was null or timestamp_return was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_MSG_EOM — the current field is at the end of message

T_ERR_FT_MISMATCH — the current field is of the wrong type

T_ERR_VAL_UNKNOWN — the current field is of unknown value

Description

TipcMsgNextTimestamp retrieves the value of the current field of a message, which must be a TIMESTAMP (eight-byte real number) field. A timestamp is the current computer wall clock time in the number of seconds since midnight January 1, 1970. If TipcMsgNextTimestamp succeeds, it advances the current field to the next field in the message.

TipcMsgNextTimestamp converts the field into the data format used by this process if necessary.

Caution

If TipcMsgNextTimestamp returns FALSE, it does not store a value in timestamp_return.

See Also

Examples

This example creates a message, appends a TIMESTAMP field, and reads the field back from the message:

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_REAL8 timestamp_val; 
 
#define USER_MT_TIMESTAMP_TEST 100 
mt = TipcMtCreate("timestamp_test", USER_MT_TIMESTAMP_TEST, 
                  "timestamp"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMsgAppendTimestamp(msg, TutGetWallTime())) { 
  return;  /* error */ 
}  
if (!TipcMsgSetCurrent(msg, 0)) { 
  return;  /* error */ 
}  
if (!TipcMsgNextTimestamp(msg, &timestamp_val)) { 
  return;  /* error */ 
}  
TutOut("timestamp_val = %s\n", TutRealToStr(timestamp_val));