RtDeleteTimer

RtDeleteTimer deletes the timer specified by the given handle.

Syntax

BOOL RtDeleteTimer(
    HANDLE hTimer
);

Parameters

hTimer

A handle to the timer to be deleted.

Return Value

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

Remarks

RtDeleteTimer deletes the specified timer, first canceling it if it has been scheduled to expire. Note that the eRTOS kernel does not maintain a reference count. Deleting a timer removes the timer entirely. You can also be use RtCloseHandle to delete a timer.

See Also:

• RtCancelTimer
• RtCloseHandle
• RtCreateTimer
• RtGetClockResolution
• RtGetClockTime
• RtGetClockTimerPeriod
• RtSetClockTime
• RtSetTimer
• RtSetTimerRelative