Stops an active timer (one waiting for its period to expire and then calling its timer function).

BOOLEAN RtCancelTimer(
    HANDLE              hTimer,
    PLARGE_INTEGER      pTimeRemaining
);

Parameters

hTimer

Handle to the timer.

pTimeRemaining

Pointer to a LARGE_INTEGER that receives the remaining time on the timer; if NULL, no time returns.

Although time is in 100ns units, the implementation uses the INtime system timer period (default 500us).

Return Values

TRUE

Success.

FALSE

Failure. For extended error information, see GetLastError.

Requirements

Notes

This function operates in the real-time portion of your application.