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