xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/norma_port_location_hint.html b/osfmk/man/norma_port_location_hint.html
index 99ecc921709178fa31eef96f20a23a6ae6ece2d4..f4c899ca12148ddb633990b3b9d5dc14bc9c4b64 100755 (executable)
--- a/osfmk/man/norma_port_location_hint.html
+++ b/osfmk/man/norma_port_location_hint.html
@@ -1 +1,44 @@
-<h2>norma_port_location_hint</h2>\r<hr>\r<p>\r<strong>Function</strong> - Guess a port's current location.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   norma_port_location_hint</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>mach_port_t</strong>                               <var>name</var>,\r                 <strong>int</strong>                                       <var>node</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rTask containing the right to locate\r<p>\r<dt> <var>name</var> \r<dd>\r[in scalar]\rName of the right to locate\r<p>\r<dt> <var>node</var> \r<dd>\r[out scalar]\rPort location hint\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>norma_port_location_hint</strong> function returns the best\rguess of <var>name</var>'s\rcurrent location.  The hint is guaranteed to be a node where\rthe port once was; it is \rguaranteed to be accurate if port has never moved.  This can be used to\rdetermine residence node for hosts, tasks, threads, etc.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="norma_task_create.html"><strong>norma_task_create</strong></a>.\r
\ No newline at end of file
+<h2>norma_port_location_hint</h2>
+<hr>
+<p>
+<strong>Function</strong> - Guess a port's current location.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   norma_port_location_hint</strong>
+                <strong>(task_t</strong>                                    <var>task</var>,
+                 <strong>mach_port_t</strong>                               <var>name</var>,
+                 <strong>int</strong>                                       <var>node</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>task</var> 
+<dd>
+[in task send right]
+Task containing the right to locate
+<p>
+<dt> <var>name</var> 
+<dd>
+[in scalar]
+Name of the right to locate
+<p>
+<dt> <var>node</var> 
+<dd>
+[out scalar]
+Port location hint
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>norma_port_location_hint</strong> function returns the best
+guess of <var>name</var>'s
+current location.  The hint is guaranteed to be a node where
+the port once was; it is 
+guaranteed to be accurate if port has never moved.  This can be used to
+determine residence node for hosts, tasks, threads, etc.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="norma_task_create.html"><strong>norma_task_create</strong></a>.