xnu-792.21.3.tar.gz

[apple/xnu.git] / osfmk / man / processor_set_destroy.html

<h2>processor_set_destroy</h2>
<hr>
<p>
<strong>Function</strong> - Destroy the target processor set object.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t	processor_set_destroy</strong>
		<strong>(processor_set_t</strong>	<var>processor_set</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<dt> <var>processor_set</var> 
<dd>
[in processor-set-control send right]
The control port for the processor 
set to be destroyed.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>processor_set_destroy</strong> function destroys the specified
processor set.  Any 
assigned processors, tasks or threads are re-assigned to the default set.  The
object port (not the name port) for the processor set is required.
<h3>RETURN VALUES</h3>
<dl>
<dt> <strong>KERN_DEFAULT_SET</strong>
<dd>
An attempt was made to destroy the default processor set.
</dl>
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="processor_set_create.html">processor_set_create</a>,
<a href="processor_assign.html">processor_assign</a>,
<a href="task_assign.html">task_assign</a>,
<a href="thread_assign.html">thread_assign</a>.