osfmk/man/task_get_assignment.html

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