xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/host_processors.html b/osfmk/man/host_processors.html
old mode 100755 (executable)
new mode 100644 (file)
index 4f0d57a..bd7c77b
--- a/osfmk/man/host_processors.html
+++ b/osfmk/man/host_processors.html
@@ -1 +1,46 @@
-<h2>host_processors</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return a list of send rights representing all processor ports.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   host_processors</strong>\r                <strong>(host_t</strong>                               <var>host_priv</var>,\r                 <strong>processor_port_array_t</strong>          <var>processor_list</var>,\r                 <strong>host_priv</strong>                      <var>processor_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 desired host.\r<p>\r<dt> <var>processor_list</var> \r<dd>\r[out pointer to dynamic array of processor send rights]\rThe set of\rprocessors existing on <var>host_priv</var>; no particular order is guaranteed.\r<p>\r<dt> <var>processor_count</var> \r<dd>\r[out scalar]\rThe number of ports returned in <var>processor_list</var>.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>host_processors</strong> function returns an array of send\rright ports for each\rprocessor 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="processor_start.html"><strong>processor_start</strong></a>,\r<a href="processor_exit.html"><strong>processor_exit</strong></a>,\r<a href="processor_info.html"><strong>processor_info</strong></a>,\r<a href="processor_control.html"><strong>processor_control</strong></a>,\r<a href="host_processor_slots.html"><strong>host_processor_slots</strong></a>.\r
\ No newline at end of file
+<h2>host_processors</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return a list of send rights representing all processor ports.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   host_processors</strong>
+                <strong>(host_t</strong>                               <var>host_priv</var>,
+                 <strong>processor_port_array_t</strong>          <var>processor_list</var>,
+                 <strong>host_priv</strong>                      <var>processor_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 desired host.
+<p>
+<dt> <var>processor_list</var> 
+<dd>
+[out pointer to dynamic array of processor send rights]
+The set of
+processors existing on <var>host_priv</var>; no particular order is guaranteed.
+<p>
+<dt> <var>processor_count</var> 
+<dd>
+[out scalar]
+The number of ports returned in <var>processor_list</var>.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>host_processors</strong> function returns an array of send
+right ports for each
+processor existing on <var>host_priv</var>.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="processor_start.html"><strong>processor_start</strong></a>,
+<a href="processor_exit.html"><strong>processor_exit</strong></a>,
+<a href="processor_info.html"><strong>processor_info</strong></a>,
+<a href="processor_control.html"><strong>processor_control</strong></a>,
+<a href="host_processor_slots.html"><strong>host_processor_slots</strong></a>.