RTEMS 4.6.0 On-Line Library

Task Manager TASK_SET_NOTE - Set task notepad entry

RTEMS Ada User's Guide

5.4.12: TASK_SET_NOTE - Set task notepad entry

CALLING SEQUENCE:

procedure Task_Set_Note (
   ID      : in     RTEMS.ID;
   Notepad : in     RTEMS.Notepad_Index;
   Note    : in     RTEMS.Unsigned32;
   Result  :    out RTEMS.Status_Codes
);

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 Ada User's Guide