xref: /xnu-10002.61.3/osfmk/man/clock_set_time.html (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1*0f4c859eSApple OSS Distributions<h2>clock_set_time</h2>
2*0f4c859eSApple OSS Distributions<hr>
3*0f4c859eSApple OSS Distributions<p><strong>Function</strong> - Set the current time.
4*0f4c859eSApple OSS Distributions<h3>SYNOPSIS</h3>
5*0f4c859eSApple OSS Distributions<pre>
6*0f4c859eSApple OSS Distributions<strong>kern_return_t   clock_set_time</strong>
7*0f4c859eSApple OSS Distributions                <strong>(clock_ctrl_t</strong>                     <var>clock_control</var>,
8*0f4c859eSApple OSS Distributions                 <strong>tvalspec_t</strong>                            <var>new_time</var><strong>);</strong>
9*0f4c859eSApple OSS Distributions</pre>
10*0f4c859eSApple OSS Distributions<h3>PARAMETERS</h3>
11*0f4c859eSApple OSS Distributions<dl>
12*0f4c859eSApple OSS Distributions<p>
13*0f4c859eSApple OSS Distributions<dt> <var>clock_control</var>
14*0f4c859eSApple OSS Distributions<dd>
15*0f4c859eSApple OSS Distributions[in clock-control send right]
16*0f4c859eSApple OSS DistributionsThe control port for the clock.
17*0f4c859eSApple OSS Distributions<p>
18*0f4c859eSApple OSS Distributions<dt> <var>new_time</var>
19*0f4c859eSApple OSS Distributions<dd>
20*0f4c859eSApple OSS Distributions[in structure]
21*0f4c859eSApple OSS DistributionsNew time
22*0f4c859eSApple OSS Distributions</dl>
23*0f4c859eSApple OSS Distributions<h3>DESCRIPTION</h3>
24*0f4c859eSApple OSS Distributions<p>
25*0f4c859eSApple OSS DistributionsThe <strong>clock_set_time</strong> function sets the time kept by a
26*0f4c859eSApple OSS Distributionsclock.  Setting the clock
27*0f4c859eSApple OSS Distributionstime will cause all pending clock alarms and sleeps to be terminated with
28*0f4c859eSApple OSS Distributionstimestamps set to the current clock time just prior to the new
29*0f4c859eSApple OSS Distributionstime being set with a
30*0f4c859eSApple OSS Distributionsreturn code of <strong>KERN_ABORTED</strong>.
31*0f4c859eSApple OSS Distributions<h3>CAUTIONS</h3>
32*0f4c859eSApple OSS Distributions<p>
33*0f4c859eSApple OSS DistributionsThe use of this function is \*Vstrongly discouraged\*O since it could affect the
34*0f4c859eSApple OSS Distributionsmonotonically increasing nature of the clock.
35*0f4c859eSApple OSS Distributions<h3>RETURN VALUES</h3>
36*0f4c859eSApple OSS Distributions<p>
37*0f4c859eSApple OSS DistributionsOnly generic errors apply.
38*0f4c859eSApple OSS Distributions<h3>RELATED INFORMATION</h3>
39*0f4c859eSApple OSS Distributions<p>
40*0f4c859eSApple OSS DistributionsFunctions:
41*0f4c859eSApple OSS Distributions<a href="host_get_clock_control.html"><strong>host_get_clock_control</strong></a>,
42*0f4c859eSApple OSS Distributions<a href="clock_set_attributes.html"><strong>clock_set_attributes</strong></a>,
43*0f4c859eSApple OSS Distributions<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,
44*0f4c859eSApple OSS Distributions<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,
45*0f4c859eSApple OSS Distributions<a href="clock_sleep.html"><strong>clock_sleep</strong></a>.
46*0f4c859eSApple OSS Distributions<p>
47*0f4c859eSApple OSS DistributionsData Structures:
48*0f4c859eSApple OSS Distributions<a href="tvalspec.html"><strong>tvalspec</strong></a>.
49