osfmk/man/processor_set_destroy.html

   1 <h2>processor_set_destroy</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Destroy the target processor set object.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   processor_set_destroy</strong>
   8                 <strong>(processor_set_t</strong>       <var>processor_set</var><strong>);</strong>
   9 </pre>
  10 <h3>PARAMETERS</h3>
  11 <dl>
  12 <dt> <var>processor_set</var>
  13 <dd>
  14 [in processor-set-control send right]
  15 The control port for the processor
  16 set to be destroyed.
  17 </dl>
  18 <h3>DESCRIPTION</h3>
  19 <p>
  20 The <strong>processor_set_destroy</strong> function destroys the specified
  21 processor set.  Any
  22 assigned processors, tasks or threads are re-assigned to the default set.  The
  23 object port (not the name port) for the processor set is required.
  24 <h3>RETURN VALUES</h3>
  25 <dl>
  26 <dt> <strong>KERN_DEFAULT_SET</strong>
  27 <dd>
  28 An attempt was made to destroy the default processor set.
  29 </dl>
  30 <h3>RELATED INFORMATION</h3>
  31 <p>
  32 Functions:
  33 <a href="processor_set_create.html">processor_set_create</a>,
  34 <a href="processor_assign.html">processor_assign</a>,
  35 <a href="task_assign.html">task_assign</a>,
  36 <a href="thread_assign.html">thread_assign</a>.