TutSetCurrentTime

Name

TutSetCurrentTime — set the current data time for the process

Synopsis

T_BOOL TutSetCurrentTime(time_val) 
T_REAL8 time_val; 

Arguments

time_val — double-precision value to use for current time

Return Values

TRUE if successful, FALSE otherwise.

Diagnostics

If TutSetCurrentTime fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TutSetCurrentTime sets the current value of data time for the current process. This causes the process to take other actions based on the specific needs of that process. The effects of setting time are determined by the time change callbacks that exist in the process.

Caution

Most processes do not tolerate time reversals. Be careful not to set time backwards unless it is really intended. Negative time values are not allowed.

See Also

TutGetCurrentTime, TutSetCurrentTimeStruct, TutTimeChangeCbCreate

Examples

This example sets the value of data time to the current wall clock time:

T_REAL8 wall_time; 
 
wall_time = TutGetWallTime(); 
if (!TutSetCurrentTime(wall_time)) { 
  /* error */ 
}