osfmk/man/task_set_info.html

   1 <H2>task_set_info</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Set task-specific information state.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>#include&lttask_info.h&gt</strong>
   8
   9 <strong>kern_return_t   task_set_info</strong>
  10                 <strong>(task_t</strong>                             <var>target_task</var>,
  11                  <strong>task_flavor_t</strong>                           <var>flavor</var>,
  12                  <strong>task_info_t</strong>                          <var>task_info</var><strong>);</strong>
  13 </pre>
  14 <h3>PARAMETERS</h3>
  15 <dl>
  16 <p>
  17 <dt> <var>target_task</var>
  18 <dd>
  19 The task whose information is to be set.
  20 <p>
  21 <dt> <var>flavor</var>
  22 <dd>
  23 Specifies the type of information to be set.  Currently the interface
  24 supports the setting of a single flavor:
  25 <strong>TASK_USER_DATA</strong>.
  26 <p>
  27 <dt> <var>task_info</var>
  28 <dd>
  29 Specifies the information to be set.
  30 </dl>
  31 <h3>DESCRIPTION</h3>
  32 <p>
  33 The <strong>task_set_info</strong> interface provides the caller with
  34 the means to set the target task's <var>user_data</var> field. This
  35 field may be used to specify arbitrarily task-specific data.
  36 <h3>NOTES</h3>
  37 <p>
  38 Currently, this interface is used exclusively to provide freshly
  39 colocated user tasks with the short-circuited RPC glue vector.
  40 <h3>RETURN VALUES</h3>
  41 <p>
  42 Only generic values apply.
  43 <h3>RELATED INFORMATION</h3>
  44 <p>