osfmk/man/thread_get_assignment.html

   1 <h2>thread_get_assignment</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return the processor set to which a thread is assigned.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   thread_get_assignment</strong>
   8                 <strong>(thread_act_t</strong>                            <var>thread</var>,
   9                  <strong>processor_set_name_t</strong>             <var>processor_set</var><strong>);</strong>
  10 </pre>
  11 <h3>PARAMETERS</h3>
  12 <dl>
  13 <p>
  14 <dt> <var>thread</var>
  15 <dd>
  16 [in thread send right]
  17 The thread whose assignment is desired.
  18 <p>
  19 <dt> <var>processor_set</var>
  20 <dd>
  21 [out processor-set-name send right]
  22 The name port for the processor
  23 set into which the thread is assigned.
  24 </dl>
  25 <h3>DESCRIPTION</h3>
  26 <p>
  27 The <strong>thread_get_assignment</strong> function returns the name
  28 port to the processor set to which <var>thread</var> is currently assigned.
  29 This port can only be used to obtain information about the processor set.
  30 <h3>RETURN VALUES</h3>
  31 <p>
  32 Only generic errors apply.
  33 <h3>RELATED INFORMATION</h3>
  34 <p>
  35 Functions:
  36 <a href="thread_assign.html"><strong>thread_assign</strong></a>,
  37 <a href="thread_assign_default.html"><strong>thread_assign_default</strong></a>,
  38 <a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
  39 <a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
  40 <a href="task_assign.html"><strong>task_assign</strong></a>.