RTEMS 4.8.0 On-Line Library

Task Manager TASK_GET_NOTE - Get task notepad entry

RTEMS Ada User's Guide

5.4.11: TASK_GET_NOTE - Get task notepad entry

CALLING SEQUENCE:

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

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