xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/host_processor_sets.html b/osfmk/man/host_processor_sets.html
index 41811d358fde9e5d462622229ec2e3f8fc2e6d78..91bb9356c33caaab1386afe37a30821455fa1b38 100755 (executable)
--- a/osfmk/man/host_processor_sets.html
+++ b/osfmk/man/host_processor_sets.html
@@ -1 +1,52 @@
-<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
\ No newline at end of file
+<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>.