xref: /xnu-11215/osfmk/man/task_threads.html (revision 186b8fce)
1*e13b1fa5SApple OSS Distributions<h2>task_threads</h2>
2*e13b1fa5SApple OSS Distributions<hr>
3*e13b1fa5SApple OSS Distributions<p>
4*e13b1fa5SApple OSS Distributions<strong>Function</strong> - Return the target task's list of threads.
5*e13b1fa5SApple OSS Distributions<h3>SYNOPSIS</h3>
6*e13b1fa5SApple OSS Distributions<pre>
7*e13b1fa5SApple OSS Distributions<strong>kern_return_t   task_threads</strong>
8*e13b1fa5SApple OSS Distributions                <strong>(task_t</strong>                                    <var>task</var>,
9*e13b1fa5SApple OSS Distributions                 <strong>thread_act_port_array_t</strong>            <var>thread_list</var>,
10*e13b1fa5SApple OSS Distributions                 <strong>mach_msg_type_number_t*</strong>           <var>thread_count</var><strong>);</strong>
11*e13b1fa5SApple OSS Distributions</pre>
12*e13b1fa5SApple OSS Distributions<h3>PARAMETERS</h3>
13*e13b1fa5SApple OSS Distributions<dl>
14*e13b1fa5SApple OSS Distributions<p>
15*e13b1fa5SApple OSS Distributions<dt> <var>task</var>
16*e13b1fa5SApple OSS Distributions<dd>
17*e13b1fa5SApple OSS Distributions[in task send right]
18*e13b1fa5SApple OSS DistributionsThe port for the task for which the thread list is to
19*e13b1fa5SApple OSS Distributionsbe returned.
20*e13b1fa5SApple OSS Distributions<p>
21*e13b1fa5SApple OSS Distributions<dt> <var>thread_list</var>
22*e13b1fa5SApple OSS Distributions<dd>
23*e13b1fa5SApple OSS Distributions[out pointer to dynamic array of thread send rights]
24*e13b1fa5SApple OSS DistributionsThe returned list of
25*e13b1fa5SApple OSS Distributionsthreads within <var>task</var>, in no particular order.
26*e13b1fa5SApple OSS Distributions<p>
27*e13b1fa5SApple OSS Distributions<dt> <var>thread_count</var>
28*e13b1fa5SApple OSS Distributions<dd>
29*e13b1fa5SApple OSS Distributions[out scalar]
30*e13b1fa5SApple OSS DistributionsThe returned count of threads in <var>thread_list</var>.
31*e13b1fa5SApple OSS Distributions</dl>
32*e13b1fa5SApple OSS Distributions<h3>DESCRIPTION</h3>
33*e13b1fa5SApple OSS Distributions<p>
34*e13b1fa5SApple OSS DistributionsThe <strong>task_threads</strong> function returns a list of the threads
35*e13b1fa5SApple OSS Distributionswithin <var>task</var>.  The calling
36*e13b1fa5SApple OSS Distributionstask or thread also receives a send right to the kernel port
37*e13b1fa5SApple OSS Distributionsfor each listed thread.
38*e13b1fa5SApple OSS Distributions<h3>RETURN VALUES</h3>
39*e13b1fa5SApple OSS Distributions<p>
40*e13b1fa5SApple OSS DistributionsOnly generic errors apply.
41*e13b1fa5SApple OSS Distributions<h3>RELATED INFORMATION</h3>
42*e13b1fa5SApple OSS Distributions<p>
43*e13b1fa5SApple OSS DistributionsFunctions:
44*e13b1fa5SApple OSS Distributions<a href="thread_create.html"><strong>thread_create</strong></a>,
45*e13b1fa5SApple OSS Distributions<a href="thread_terminate.html"><strong>thread_terminate</strong></a>,
46*e13b1fa5SApple OSS Distributions<a href="thread_suspend.html"><strong>thread_suspend</strong></a>.
47