Changeset b5a31d4 in rtems


Ignore:
Timestamp:
Jan 23, 2000, 7:06:09 PM (20 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
8d37343
Parents:
a6900508
Message:

Added rtems_task_variable_get from Eric Norum.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/task.t

    ra6900508 rb5a31d4  
    2525@item @code{@value{DIRPREFIX}task_suspend} - Suspend a task
    2626@item @code{@value{DIRPREFIX}task_resume} - Resume a task
    27 @item @code{@value{DIRPREFIX}task_is_suspended} - Determine if a task is Suspended
     27@item @code{@value{DIRPREFIX}task_is_suspended} - Determine if a task is suspended
    2828@item @code{@value{DIRPREFIX}task_set_priority} - Set task priority
    2929@item @code{@value{DIRPREFIX}task_mode} - Change current task's mode
     
    3333@item @code{@value{DIRPREFIX}task_wake_when} - Wake up when specified 
    3434@item @code{@value{DIRPREFIX}task_variable_add} - Associate per task variable
     35@item @code{@value{DIRPREFIX}task_variable_add} - Obtain value of a a per task variable
    3536@item @code{@value{DIRPREFIX}task_variable_delete} - Remove per task variable
    3637@end itemize
     
    16371638@page
    16381639
    1639 @subsection TASK_VARIABLE_DELETE - Remove per task variable
    1640 
    1641 @cindex per-task variable
    1642 @cindex task private variable
    1643 @cindex task private data
     1640@subsection TASK_VARIABLE_GET - Obtain value of a per task variable
     1641
     1642@cindex get per-task variable
     1643@cindex obtain per-task variable
    16441644
    16451645@subheading CALLING SEQUENCE:
    16461646
    16471647@ifset is-C
    1648 @findex rtems_task_variable_delete
    1649 @example
    1650 rtems_status_code rtems_task_variable_delete(
     1648@findex rtems_task_variable_get
     1649@example
     1650rtems_status_code rtems_task_variable_get(
    16511651  rtems_id  tid,
    1652   void    **ptr
     1652  void    **ptr,
     1653  void    **result
    16531654);
    16541655@end example
     
    16601661   Id          : in     RTEMS.ID;
    16611662   Ptr         : in     RTEMS.Address;
     1663   Value       :    out RTEMS.Address;
    16621664   Result      :    out RTEMS.Status_Codes
    16631665);
     
    16721674
    16731675@subheading DESCRIPTION:
     1676This directive looks up the private value of a task variable for a
     1677specified task and stores that value in the location pointed to by
     1678the result argument.  The specified task is usually not the calling
     1679task, which can get its private value by directly accessing the variable.
     1680
     1681@subheading NOTES:
     1682
     1683NONE
     1684@page
     1685
     1686@subsection TASK_VARIABLE_DELETE - Remove per task variable
     1687
     1688@cindex per-task variable
     1689@cindex task private variable
     1690@cindex task private data
     1691
     1692@subheading CALLING SEQUENCE:
     1693
     1694@ifset is-C
     1695@findex rtems_task_variable_delete
     1696@example
     1697rtems_status_code rtems_task_variable_delete(
     1698  rtems_id  tid,
     1699  void    **ptr
     1700);
     1701@end example
     1702@end ifset
     1703
     1704@ifset is-Ada
     1705@example
     1706procedure Task_Variable_Delete (
     1707   Id          : in     RTEMS.ID;
     1708   Ptr         : in     RTEMS.Address;
     1709   Result      :    out RTEMS.Status_Codes
     1710);
     1711@end example
     1712@end ifset
     1713
     1714@subheading DIRECTIVE STATUS CODES:
     1715@code{@value{RPREFIX}SUCCESSFUL} - per task variable added successfully@*
     1716@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
     1717@code{@value{RPREFIX}NO_MEMORY} - invalid task id@*
     1718@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks@*
     1719
     1720@subheading DESCRIPTION:
    16741721This directive removes the given location from a task's context.
    16751722
Note: See TracChangeset for help on using the changeset viewer.