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