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