osfmk/man/processor_get_assignment.html

   1 <h2>processor_get_assignment</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Get current assignment for a processor.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   processor_get_assignment</strong>
   8                 <strong>(processor_t</strong>   <var>processor</var>,
   9                 <strong>processor_set_name_t</strong>   <var>assigned_set</var><strong>);</strong>
  10 </pre>
  11 <h3>PARAMETERS</h3>
  12 <dl>
  13 <dt> <var>processor</var>
  14 <dd>
  15 [in processor send right]
  16 The processor whose assignment is desired.
  17 <dt> <var>new_set</var>
  18 <dd>
  19 [out processor-set-name send right]
  20 The name port for the processor
  21 set to which <var>processor</var> is currently assigned.
  22 </dl>
  23 <h3>DESCRIPTION</h3>
  24 <p>
  25 The <strong>processor_get_assignment</strong> function returns the name port for the
  26 processor set to which a desired processor is currently assigned.
  27 <h3>RETURN VALUES</h3>
  28 <dl>
  29 <dt> <strong>KERN_FAILURE</strong>
  30 <dd>
  31 Processor is either shut down of off-line.
  32 </dl>
  33 <h3>RELATED INFORMATION</h3>
  34 <p>
  35 Functions:
  36 <a href="processor_assign.html">processor_assign</a>,
  37 <a href="processor_set_create.html">processor_set_create</a>,
  38 <a href="processor_info.html">processor_info</a>,
  39 <a href="task_assign.html">task_assign</a>,
  40 <a href="thread_assign.html">thread_assign</a>.