RTEMS 4.10.0 On-Line Library

Timer Manager TIMER_IDENT - Get ID of a timer

RTEMS C User's Guide

8.4.2: TIMER_IDENT - Get ID of a timer

CALLING SEQUENCE:

rtems_status_code rtems_timer_ident(
  rtems_name  name,
  rtems_id   *id
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - timer identified successfully
RTEMS_INVALID_ADDRESS - id is NULL
RTEMS_INVALID_NAME - timer name not found

DESCRIPTION:

This directive obtains the timer id associated with the timer name to be acquired. If the timer name is not unique, then the timer id will match one of the timers with that name. However, this timer id is not guaranteed to correspond to the desired timer. The timer id is used to access this timer in other timer related directives.

NOTES:

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

RTEMS C User's Guide