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