RtCancelTimer

RtCancelTimer cancels the expiration of the indicated timer.

Syntax

Copy

BOOL RtCancelTimer(
    [in]    HANDLE hTimer,
    [out]   PLARGE_INTEGER pTimeRemaining
);

Parameters

[in] hTimer

An wRTOS-specific handle to the timer.

[out] 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 100 ns units.

Return Value

If the function succeeds, it returns TRUE. If invalid parameters are specified, it returns FALSE.

Remarks

RtCancelTimer cancels the specified timer but does not delete it.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtApi.h	RtApi.lib (Windows), Startup.lib (RTSS)