xref: /xnu-8019.80.24/osfmk/man/clock_get_time.html (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1*a325d9c4SApple OSS Distributions<h2>clock_get_time</h2>
2*a325d9c4SApple OSS Distributions<hr>
3*a325d9c4SApple OSS Distributions<p>
4*a325d9c4SApple OSS Distributions<strong>Function</strong> - Return the current time.
5*a325d9c4SApple OSS Distributions<h3>SYNOPSIS</h3>
6*a325d9c4SApple OSS Distributions<pre>
7*a325d9c4SApple OSS Distributions<strong>kern_return_t   clock_get_time</strong>
8*a325d9c4SApple OSS Distributions                <strong>(clock_t</strong>                             <var>clock_name</var>,
9*a325d9c4SApple OSS Distributions                 <strong>tvalspec_t</strong>                            <var>cur_time</var><strong>);</strong>
10*a325d9c4SApple OSS Distributions</pre>
11*a325d9c4SApple OSS Distributions<h3>PARAMETERS</h3>
12*a325d9c4SApple OSS Distributions<dl>
13*a325d9c4SApple OSS Distributions<p>
14*a325d9c4SApple OSS Distributions<dt> <var>clock_name</var>
15*a325d9c4SApple OSS Distributions<dd>
16*a325d9c4SApple OSS Distributions[in clock-name send right]
17*a325d9c4SApple OSS DistributionsThe name (or control) port for the clock.
18*a325d9c4SApple OSS Distributions<p>
19*a325d9c4SApple OSS Distributions<dt> <var>cur_time</var>
20*a325d9c4SApple OSS Distributions<dd>
21*a325d9c4SApple OSS Distributions[out structure]
22*a325d9c4SApple OSS DistributionsCurrent time
23*a325d9c4SApple OSS Distributions</dl>
24*a325d9c4SApple OSS Distributions<h3>DESCRIPTION</h3>
25*a325d9c4SApple OSS Distributions<p>
26*a325d9c4SApple OSS DistributionsThe <strong>clock_get_time</strong> function returns the current time
27*a325d9c4SApple OSS Distributionskept by a clock.  The
28*a325d9c4SApple OSS Distributionsvalue returned is a monotonically increasing value (unless tampered
29*a325d9c4SApple OSS Distributionswith via the
30*a325d9c4SApple OSS Distributions<strong>clock_set_time</strong> function).
31*a325d9c4SApple OSS Distributions<h3>RETURN VALUES</h3>
32*a325d9c4SApple OSS Distributions<p>
33*a325d9c4SApple OSS DistributionsOnly generic errors apply.
34*a325d9c4SApple OSS Distributions<h3>RELATED INFORMATION</h3>
35*a325d9c4SApple OSS Distributions<p>
36*a325d9c4SApple OSS DistributionsFunctions:
37*a325d9c4SApple OSS Distributions<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,
38*a325d9c4SApple OSS Distributions<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,
39*a325d9c4SApple OSS Distributions<a href="clock_map_time.html"><strong>clock_map_time</strong></a>,
40*a325d9c4SApple OSS Distributions<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,
41*a325d9c4SApple OSS Distributions<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,
42*a325d9c4SApple OSS Distributions<a href="clock_set_time.html"><strong>clock_set_time</strong></a>.
43*a325d9c4SApple OSS Distributions<p>
44*a325d9c4SApple OSS DistributionsData Structures:
45*a325d9c4SApple OSS Distributions<a href="tvalspec.html"><strong>tvalspec</strong></a>.
46