osfmk/man/task_threads.html

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