ITimer::Freeze Method

---

Halts the timer temporarily.

Syntax

HRESULT Freeze(
    BOOL fTrue
);

Parameters

fTrue

[in] Boolean value that indicates the state of the timer clock. True halts the clock, and false restarts it.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

For each time you halt the clock by calling Freeze and passing true as the parameter value, you must call Freeze and pass a value of false to restart the clock.

Freezing a timer does not actually stop the computer's clock. It simply suspends all callbacks and locks the reported time from GetCurrentTime. For example, if a timer is frozen at local time 2:01 A.M., and then five real seconds later it is unfrozen, the reported time will be 2:06 A.M. and not 2:01 A.M. Any timer events that came due while the clock was frozen will be serviced immediately when the clock is unfrozen.