RTEMS 4.5.1-pre3 On-Line Library

Task Manager TASK_SET_NOTE - Set task notepad entry

RTEMS C User's Guide

5.4.12: TASK_SET_NOTE - Set task notepad entry

CALLING SEQUENCE:

rtems_status_code rtems_task_set_note(
  rtems_id         id,
  rtems_unsigned32 notepad,
  rtems_unsigned32 note
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - task's note set successfully
RTEMS_INVALID_ID - invalid task id
RTEMS_INVALID_NUMBER - invalid notepad location

DESCRIPTION:

This directive sets the notepad entry for the task specified by id to the value note.

NOTES:

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

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

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

Setting a notepad location of a global task which does not reside on the local node will generate a request to the remote node to set the specified notepad entry.

RTEMS C User's Guide