[apple/xnu.git] / osfmk / man / task_threads.html

<h2>task_threads</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return the target task's list of threads.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_threads</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>thread_act_port_array_t</strong>            <var>thread_list</var>,\r                 <strong>mach_msg_type_number_t*</strong>           <var>thread_count</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe port for the task for which the thread list is to \rbe returned.\r<p>\r<dt> <var>thread_list</var> \r<dd>\r[out pointer to dynamic array of thread send rights]\rThe returned list of \rthreads within <var>task</var>, in no particular order.\r<p>\r<dt> <var>thread_count</var> \r<dd>\r[out scalar]\rThe returned count of threads in <var>thread_list</var>.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_threads</strong> function returns a list of the threads\rwithin <var>task</var>.  The calling \rtask or thread also receives a send right to the kernel port\rfor each listed thread.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="thread_create.html"><strong>thread_create</strong></a>,\r<a href="thread_terminate.html"><strong>thread_terminate</strong></a>,\r<a href="thread_suspend.html"><strong>thread_suspend</strong></a>.\r