RtDeleteTimer

RtDeleteTimer deletes the timer specified by the given handle.

Syntax

Copy

BOOL RtDeleteTimer(
    [in]    HANDLE hTimer
);

Parameters

[in] hTimer

A wRTOS-specific handle to the timer to be deleted.

Return Value

If the function succeeds, it returns TRUE. If an invalid parameter is specified, it returns FALSE.

Remarks

RtDeleteTimer deletes the specified timer, first canceling it if it has been scheduled to expire. Note that timer handles are not Windows object handles, and the wRTOS Subsystem does not maintain a reference count. Deleting a timer removes the timer entirely. RtCloseHandle can also be used to delete a timer.

Requirements

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