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