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