xnu-7195.60.75.tar.gz

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

<h2>host_get_time</h2>
<hr>
<p>
<strong>Function</strong> - Return the current time.
<h3>SYNOPSIS</h3>
<pre>
<strong>#include&lt mach/mach_host.h&gt</strong>

<strong>kern_return_t   host_get_time</strong>
                <strong>(host_t</strong>                                    <var>host</var>,
                 <strong>time_value_t</strong>                      <var>current_time</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>host</var>
<dd>
[in host-name port] The name port the host for which the time is to be set.
<p>
<dt> <var>current_time</var>
<dd>
[out structure] Returned time value.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>host_get_time</strong> function returns the current time
as seen by that <var>host</var>.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="host_adjust_time.html"><strong>host_adjust_time</strong></a>,
<a href="host_set_time.html"><strong>host_set_time</strong></a>.
<p>
Data Structures:
time_value.