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

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