RTEMS 4.8.0 On-Line Library

Timer Manager TIMER_CANCEL - Cancel a timer

RTEMS C User's Guide

8.4.3: TIMER_CANCEL - Cancel a timer

CALLING SEQUENCE:

rtems_status_code rtems_timer_cancel(
  rtems_id id
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - timer canceled successfully
RTEMS_INVALID_ID - invalid timer id

DESCRIPTION:

This directive cancels the timer id. This timer will be reinitiated by the next invocation of rtems_timer_reset, rtems_timer_fire_after, or rtems_timer_fire_when with this id.

NOTES:

This directive will not cause the running task to be preempted.

RTEMS C User's Guide