RTEMS 4.9.2 On-Line Library

Task Manager TASK_IDENT - Get ID of a task

RTEMS C User's Guide

5.4.2: TASK_IDENT - Get ID of a task

CALLING SEQUENCE:

rtems_status_code rtems_task_ident(
  rtems_name  name,
  uint32_t    node,
  rtems_id   *id
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - task identified successfully
RTEMS_INVALID_ADDRESS - id is NULL
RTEMS_INVALID_NAME - invalid task name
RTEMS_INVALID_NODE - invalid node id

DESCRIPTION:

This directive obtains the task id associated with the task name specified in name. A task may obtain its own id by specifying RTEMS_SELF or its own task name in name. If the task name is not unique, then the task id returned will match one of the tasks with that name. However, this task id is not guaranteed to correspond to the desired task. The task id, returned in id, is used in other task related directives to access the task.

NOTES:

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

If node is RTEMS_SEARCH_ALL_NODES, all nodes are searched with the local node being searched first. All other nodes are searched with the lowest numbered node searched first.

If node is a valid node number which does not represent the local node, then only the tasks exported by the designated node are searched.

This directive does not generate activity on remote nodes. It accesses only the local copy of the global object table.

RTEMS C User's Guide