xnu-2422.1.72.tar.gz

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

<h2>clock_get_time</h2>
<hr>
<p>
<strong>Function</strong> - Return the current time.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   clock_get_time</strong>
                <strong>(clock_t</strong>                             <var>clock_name</var>,
                 <strong>tvalspec_t</strong>                            <var>cur_time</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>clock_name</var> 
<dd>
[in clock-name send right]
The name (or control) port for the clock.
<p>
<dt> <var>cur_time</var> 
<dd>
[out structure]
Current time
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>clock_get_time</strong> function returns the current time
kept by a clock.  The
value returned is a monotonically increasing value (unless tampered
with via the 
<strong>clock_set_time</strong> function).
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,
<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,
<a href="clock_map_time.html"><strong>clock_map_time</strong></a>,
<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,
<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,
<a href="clock_set_time.html"><strong>clock_set_time</strong></a>.
<p>
Data Structures:
<a href="tvalspec.html"><strong>tvalspec</strong></a>.