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