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

<h2>host_processor_sets</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return a list of send rights representing all processor set name ports.\r\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   host_processor_sets</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>processor_set_name_port_array_t</strong><var>processor_set_name_list</var>,\r                 <strong>host_priv</strong>             <var>processor_set_name_count</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>host_priv</var> \r<dd>\r[in host-control send right]\rThe control port for the host for which the \rprocessor sets are desired.\r<p>\r<dt> <var>processor_set_name_list</var> \r<dd>\r[out pointer to dynamic array of processor-set-name send rights]\rThe \rset of processor set name ports for those currently existing on\r<var>host_priv</var>; no particular order is guaranteed.\r<p>\r<dt> <var>processor_set_name_count</var> \r<dd>\r[out scalar]\rThe number of processor set names returned.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>host_processor_sets</strong> function returns send rights\rfor the name ports for \reach processor set currently existing on host.\r<h3>NOTES</h3>\r<p>\rIf control ports to the processor sets are needed, use \r<strong>host_processor_set_priv</strong>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="host_processor_set_priv.html"><strong>host_processor_set_priv</strong></a>,\r<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,\r<a href="processor_set_tasks.html"><strong>processor_set_tasks</strong></a>,\r<a href="processor_set_threads.html"><strong>processor_set_threads</strong></a>.\r