RTEMS 4.9.2 On-Line Library

Task Manager TASK_GET_NOTE - Get task notepad entry

RTEMS C User's Guide

5.4.12: TASK_GET_NOTE - Get task notepad entry

CALLING SEQUENCE:

rtems_status_code rtems_task_get_note(
  rtems_id  id,
  uint32_t  notepad,
  uint32_t *note
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - note obtained successfully
RTEMS_INVALID_ADDRESS - note is NULL
RTEMS_INVALID_ID - invalid task id
RTEMS_INVALID_NUMBER - invalid notepad location

DESCRIPTION:

This directive returns the note contained in the notepad location of the task specified by id.

NOTES:

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

If id is set to RTEMS_SELF, the calling task accesses its own notepad.

The sixteen notepad locations can be accessed using the constants RTEMS_NOTEPAD_0 through RTEMS_NOTEPAD_15.

Getting a note of a global task which does not reside on the local node will generate a request to the remote node to obtain the notepad entry of the specified task.

RTEMS C User's Guide