osCancelTimer function

Declaration:

BOOL osCancelTimer(
  HANDLE Handle
);

Parameters:

Handle

The handle to the timer object to be canceled.

Return value:

Returns TRUE on success or FALSE on failure. To retrieve extended error information, call the osGetLastError function.

Description:

This function immediately stops the specified timer. Upon cancellation, the timer's state is transitioned to signaled, and any tasks currently pending on the timer are released.

Timer objects provide mechanisms for task synchronization relative to specific time points or intervals. Functionally similar to events, timers transition to the signaled state when a specified duration elapses and return to the non-signaled state upon being reset.

Once a timer has been stopped, it must be reconfigured using the osSetTimer function before it can be restarted.

For additional details regarding timer behavior and synchronization logic, please refer to the Timer Objects section.

This function is available only when the OS_USE_TIMER configuration constant is set to 1.

Version:	1.0
Header file:	OS_Timer.h (include OS_API.h)
See also:	BOOL, FALSE, HANDLE, osCreateTimer, osGetLastError, osSetTimer, timers, TRUE

SpaceShadow documentation