RTEMS 4.6.99.3 On-Line Library

Timer Manager TIMER_DELETE - Delete a timer

RTEMS C User's Guide

8.4.4: TIMER_DELETE - Delete a timer

CALLING SEQUENCE:

rtems_status_code rtems_timer_delete(
  rtems_id id
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - timer deleted successfully
RTEMS_INVALID_ID - invalid timer id

DESCRIPTION:

This directive deletes the timer specified by id. If the timer is running, it is automatically canceled. The TMCB for the deleted timer is reclaimed by RTEMS.

NOTES:

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

A timer can be deleted by a task other than the task which created the timer.

RTEMS C User's Guide