Changeset a6900508 in rtems


Ignore:
Timestamp:
Jan 23, 2000, 6:59:17 PM (20 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
b5a31d4
Parents:
41b27b94
Message:

Updated to reflect changing to void * on task variables by
Eric Norum <eric@…>.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/task.t

    r41b27b94 ra6900508  
    295295Per task variables are used to support global variables whose value
    296296may be unique to a task. After indicating that a variable should be
    297 treated as private or pre-task.  The task can access and modify the
     297treated as private (i.e. per-task) the task can access and modify the
    298298variable, but the modifications will not appear to other tasks, and
    299299other tasks' modifications to that variable will not affect the value
     
    15921592rtems_status_code rtems_task_variable_add(
    15931593  rtems_id  tid,
    1594   int      *ptr
     1594  void    **ptr,
     1595  void    (*dtor)(void *)
    15951596);
    15961597@end example
     
    16111612@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
    16121613@code{@value{RPREFIX}NO_MEMORY} - invalid task id@*
    1613 @code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks
    1614 @code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set
     1614@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks@*
    16151615
    16161616@subheading DESCRIPTION:
     
    16221622seen by the task.  This is accomplished by saving and restoring the
    16231623variable's value each time a task switch occurs to or from the calling task.
     1624If the dtor argument is non-NULL it specifies the address of a `destructor'
     1625function which will be called when the task is deleted.  The argument
     1626passed to the destructor function is the task's value of the variable.
    16241627
    16251628@subheading NOTES:
     
    16301633is to have a single task variable that is a pointer to a dynamically
    16311634allocated structure containing the task's private `global' data.
     1635In this case the destructor function could be `free'.
    16321636
    16331637@page
     
    16461650rtems_status_code rtems_task_variable_delete(
    16471651  rtems_id  tid,
    1648   int      *ptr
     1652  void    **ptr
    16491653);
    16501654@end example
     
    16651669@code{@value{RPREFIX}INVALID_ID} - invalid task id@*
    16661670@code{@value{RPREFIX}NO_MEMORY} - invalid task id@*
    1667 @code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks
    1668 @code{@value{RPREFIX}NOT_DEFINED} - system date and time is not set
     1671@code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - not supported on remote tasks@*
    16691672
    16701673@subheading DESCRIPTION:
     
    16741677
    16751678NONE
    1676 
Note: See TracChangeset for help on using the changeset viewer.