xnu-1504.3.12.tar.gz

[apple/xnu.git] / osfmk / man / task_set_info.html

<H2>task_set_info</h2>
<hr>
<p>
<strong>Function</strong> - Set task-specific information state.
<h3>SYNOPSIS</h3>
<pre>
<strong>#include&lttask_info.h&gt</strong>

<strong>kern_return_t   task_set_info</strong>
                <strong>(task_t</strong>                             <var>target_task</var>,
                 <strong>task_flavor_t</strong>                           <var>flavor</var>,
                 <strong>task_info_t</strong>                          <var>task_info</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>target_task</var> 
<dd>
The task whose information is to be set.
<p>
<dt> <var>flavor</var> 
<dd>
Specifies the type of information to be set.  Currently the interface
supports the setting of a single flavor:
<strong>TASK_USER_DATA</strong>.
<p>
<dt> <var>task_info</var> 
<dd>
Specifies the information to be set.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>task_set_info</strong> interface provides the caller with
the means to set the target task's <var>user_data</var> field. This
field may be used to specify arbitrarily task-specific data.
<h3>NOTES</h3>
<p>
Currently, this interface is used exclusively to provide freshly
colocated user tasks with the short-circuited RPC glue vector.
<h3>RETURN VALUES</h3>
<p>
Only generic values apply.
<h3>RELATED INFORMATION</h3>
<p>