InitTimerTickInterval

This method of the IUserEventTimer interface sets the internal timer tick.

Declaration

HRESULT InitTimerTickInterval (UINT uTimerTickIntervalMs);

Parameters

The uTimerTickIntervalMs argument is the number of milliseconds to let “tick” between checks for expiry of timers, else is zero to set a default interval.

Return Value

The function returns zero for success, else an error code.

Behaviour

The internal timer tick cannot be changed while timers remain set. If any timers are (still) set when this method is called, then the function fails (returning E_FAIL).

Otherwise, the function accepts the given interval, no matter how large, except for translating zero to the default, which is presently 5 seconds.