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

<h2>processor_set_default</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return the default processor set.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t	processor_set_default</strong>\r		<strong>(host_t</strong>	<var>host</var>,\r		<strong>processor_set_name_t</strong>	<var>default_set_name</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>host</var> \r<dd>\r[in host-name send right]\rThe name (or control) port for the host for \rwhich the default processor set is desired.\r<dt> <var>default_set_name</var> \r<dd>\r[out processor-set-name send right]\rThe returned name port for the\rdefault processor set.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_set_default</strong> function returns the name\rport for the default\rprocessor set for the specified host.  The default processor\rset is used by all threads, \rtasks and processors that are not explicitly assigned to other sets.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="processor_set_info.html">processor_set_info</a>,\r<a href="thread_assign.html">thread_assign</a>,\r<a href="task_assign.html">task_assign</a>.\r