summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2000-01-23 19:06:09 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2000-01-23 19:06:09 +0000
commitb5a31d4479708e823412bce987b08568a43ff7a1 (patch)
tree142f0c159f7e81fff99c787ab30a7b2544cae88f /doc
parenta690050805e44512f0ec4529231a492842954261 (diff)
downloadrtems-b5a31d4479708e823412bce987b08568a43ff7a1.tar.bz2
Added rtems_task_variable_get from Eric Norum.
Diffstat (limited to 'doc')
-rw-r--r--doc/user/task.t49
1 files changed, 48 insertions, 1 deletions
diff --git a/doc/user/task.t b/doc/user/task.t
index 88bc2d9591..106bc31855 100644
--- a/doc/user/task.t
+++ b/doc/user/task.t
@@ -24,7 +24,7 @@ by the task manager are:
@item @code{@value{DIRPREFIX}task_delete} - Delete a task
@item @code{@value{DIRPREFIX}task_suspend} - Suspend a task
@item @code{@value{DIRPREFIX}task_resume} - Resume a task
-@item @code{@value{DIRPREFIX}task_is_suspended} - Determine if a task is Suspended
+@item @code{@value{DIRPREFIX}task_is_suspended} - Determine if a task is suspended
@item @code{@value{DIRPREFIX}task_set_priority} - Set task priority
@item @code{@value{DIRPREFIX}task_mode} - Change current task's mode
@item @code{@value{DIRPREFIX}task_get_note} - Get task notepad entry
@@ -32,6 +32,7 @@ by the task manager are:
@item @code{@value{DIRPREFIX}task_wake_after} - Wake up after interval
@item @code{@value{DIRPREFIX}task_wake_when} - Wake up when specified
@item @code{@value{DIRPREFIX}task_variable_add} - Associate per task variable
+@item @code{@value{DIRPREFIX}task_variable_add} - Obtain value of a a per task variable
@item @code{@value{DIRPREFIX}task_variable_delete} - Remove per task variable
@end itemize
@@ -1636,6 +1637,52 @@ In this case the destructor function could be `free'.
@page
+@subsection TASK_VARIABLE_GET - Obtain value of a per task variable
+
+@cindex get per-task variable
+@cindex obtain per-task variable
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@findex rtems_task_variable_get
+@example
+rtems_status_code rtems_task_variable_get(
+ rtems_id tid,
+ void **ptr,
+ void **result
+);
+@end example
+@end ifset
+
+@ifset is-Ada
+@example
+procedure Task_Variable_Delete (
+ Id : in RTEMS.ID;
+ Ptr : in RTEMS.Address;
+ Value : out RTEMS.Address;
+ Result : out RTEMS.Status_Codes
+);
+@end example
+@end ifset
+
+@subheading DIRECTIVE STATUS CODES:
+@code{@value{RPREFIX}SUCCESSFUL} - per task variable added successfully@*
+@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
+@code{@value{RPREFIX}NO_MEMORY} - invalid task id@*
+@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks@*
+
+@subheading DESCRIPTION:
+This directive looks up the private value of a task variable for a
+specified task and stores that value in the location pointed to by
+the result argument. The specified task is usually not the calling
+task, which can get its private value by directly accessing the variable.
+
+@subheading NOTES:
+
+NONE
+@page
+
@subsection TASK_VARIABLE_DELETE - Remove per task variable
@cindex per-task variable