Freeze method

Halts the timer temporarily.

Syntax

HRESULT retVal = object.Freeze(fFreeze);

Parameters

  • fFreeze [in]
    Type: BOOL

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

Remarks

Each time that 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.

When you freeze a timer, the computer's clock does not actually stop. It suspends all callbacks and locks the reported time. 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 come due while the clock is frozen will be serviced immediately when the clock is unfrozen.