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

<h2>clock_set_time</h2>\r<hr>\r<p><strong>Function</strong> - Set the current time.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   clock_set_time</strong>\r                <strong>(clock_ctrl_t</strong>                     <var>clock_control</var>,\r                 <strong>tvalspec_t</strong>                            <var>new_time</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>clock_control</var> \r<dd>\r[in clock-control send right]\rThe control port for the clock.\r<p>\r<dt> <var>new_time</var> \r<dd>\r[in structure]\rNew time\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>clock_set_time</strong> function sets the time kept by a\rclock.  Setting the clock \rtime will cause all pending clock alarms and sleeps to be terminated with\rtimestamps set to the current clock time just prior to the new\rtime being set with a\rreturn code of <strong>KERN_ABORTED</strong>.\r<h3>CAUTIONS</h3>\r<p>\rThe use of this function is \*Vstrongly discouraged\*O since it could affect the\rmonotonically increasing nature of the clock.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="host_get_clock_control.html"><strong>host_get_clock_control</strong></a>,\r<a href="clock_set_attributes.html"><strong>clock_set_attributes</strong></a>,\r<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,\r<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,\r<a href="clock_sleep.html"><strong>clock_sleep</strong></a>.\r<p>\rData Structures:\r<a href="tvalspec.html"><strong>tvalspec</strong></a>.\r