RtCancelTimer
RtCancelTimer cancels the expiration of the indicated timer.
Syntax
BOOL RtCancelTimer( HANDLE hTimer, PLARGE_INTEGER pTimeRemaining );
Parameters
hTimer
An RTX64-specific handle to the timer.
pTimeRemaining
A pointer to a LARGE_INTEGER to store the time remaining on the canceled timer. If the pointer is non-NULL, the LARGE_INTEGER will be written with the time remaining on the timer at the time of cancellation. The time remaining is calculated relative to the current value of the clock associated with the time at creation and is specified in 100ns units.
Return Value
TRUE if the function completes successfully, FALSE if invalid parameters are specified
Remarks
RtCancelTimer cancels the specified timer, but does not delete it.
Requirements
Minimum Supported Version | RTX64 2013 |
Header | Rtapi.h |
Library | RtApi.lib (Windows), Rtx_Rtss.lib (RTSS) |
See Also: