osfmk/man/clock_set_time.html

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