xnu-2422.1.72.tar.gz

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

<h2>host_processor_sets</h2>
<hr>
<p>
<strong>Function</strong> - Return a list of send rights representing all processor set name ports.

<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   host_processor_sets</strong>
                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
                 <strong>processor_set_name_port_array_t</strong><var>processor_set_name_list</var>,
                 <strong>host_priv</strong>             <var>processor_set_name_count</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>host_priv</var> 
<dd>
[in host-control send right]
The control port for the host for which the 
processor sets are desired.
<p>
<dt> <var>processor_set_name_list</var> 
<dd>
[out pointer to dynamic array of processor-set-name send rights]
The 
set of processor set name ports for those currently existing on
<var>host_priv</var>; no particular order is guaranteed.
<p>
<dt> <var>processor_set_name_count</var> 
<dd>
[out scalar]
The number of processor set names returned.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>host_processor_sets</strong> function returns send rights
for the name ports for 
each processor set currently existing on host.
<h3>NOTES</h3>
<p>
If control ports to the processor sets are needed, use 
<strong>host_processor_set_priv</strong>.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="host_processor_set_priv.html"><strong>host_processor_set_priv</strong></a>,
<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
<a href="processor_set_tasks.html"><strong>processor_set_tasks</strong></a>,
<a href="processor_set_threads.html"><strong>processor_set_threads</strong></a>.