xnu-1504.3.12.tar.gz

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

<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>.