xnu-1699.22.81.tar.gz

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

diff --git a/osfmk/man/host_processor_set_priv.html b/osfmk/man/host_processor_set_priv.html
index c8ec2527103a91d5ac968d36daf8a4db5a010367..bb5375ba2884f00e6a3246696dc264a373c6fe6f 100755 (executable)
--- a/osfmk/man/host_processor_set_priv.html
+++ b/osfmk/man/host_processor_set_priv.html
@@ -1 +1,48 @@
-<h2>host_processor_set_priv</h2>\r<hr>\r<p>\r<strong>Function</strong> - Translate a processor set name port\r  into a processor set control port.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   host_processor_set_priv</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>processor_set_name_t</strong>                  <var>set_name</var>,\r                 <strong>processor_set_t</strong>                  <var>processor_set</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 set is desired.\r<p>\r<dt> <var>set_name</var> \r<dd>\r[in processor-set-name send right]\rThe name port for the processor set \rdesired.\r<p>\r<dt> <var>processor_set</var> \r<dd>\r[out processor-set-control send right]\rThe returned processor set\rcontrol port.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>host_processor_set_priv</strong> function returns send rights\rfor the control port \rfor a specified processor set currently existing on <var>host_priv</var>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="host_processor_sets.html"><strong>host_processor_sets</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_set_priv</h2>
+<hr>
+<p>
+<strong>Function</strong> - Translate a processor set name port
+  into a processor set control port.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   host_processor_set_priv</strong>
+                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
+                 <strong>processor_set_name_t</strong>                  <var>set_name</var>,
+                 <strong>processor_set_t</strong>                  <var>processor_set</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 set is desired.
+<p>
+<dt> <var>set_name</var> 
+<dd>
+[in processor-set-name send right]
+The name port for the processor set 
+desired.
+<p>
+<dt> <var>processor_set</var> 
+<dd>
+[out processor-set-control send right]
+The returned processor set
+control port.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>host_processor_set_priv</strong> function returns send rights
+for the control port 
+for a specified processor set currently existing on <var>host_priv</var>.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="host_processor_sets.html"><strong>host_processor_sets</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>.