TutGetCurrentTimeStruct

Name

TutGetCurrentTimeStruct — get the current SmartSockets data time as a time struct

Synopsis

T_BOOL TutGetCurrentTimeStruct(time_return) 
T_TIME_STRUCT *time_return; 

Arguments

time_return — pointer to location to store time structure

Return Values

TRUE if successful, FALSE otherwise.

Diagnostics

None

Description

TutGetCurrentTimeStruct returns the current SmartSockets data time into a T_TIME_STRUCT. Data time is the time that is contained in SmartSockets time messages. The interpretation of the current data time is application-specific. Normally, the data time has some relationship to the computer wall clock time, but this is not always the case.

Caution

TutGetCurrentTimeStruct does not return the current wall clock time. Use TutGetWallTimeStruct for that.

See Also

TutGetWallTimeStruct, TutTimeNumToStr

Examples

This example prints the current SmartSockets data time:

T_TIME_STRUCT time_struct; 
 
if (!TutGetCurrentTimeStruct(&time_struct)) { 
  TutOut("Could not get current data time\n"); 
  return; 
} 
TutOut("Current data time is %d.%06d\n", 
        time_struct.sec, time_struct.usec);