xnu-792.21.3.tar.gz

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

diff --git a/osfmk/man/clock_alarm_reply.html b/osfmk/man/clock_alarm_reply.html
index 0b951e7c83ff68fc981e58b5a03effb57de249a8..04b477954241e0e7f1f4082316e94a1b4dc199c0 100755 (executable)
--- a/osfmk/man/clock_alarm_reply.html
+++ b/osfmk/man/clock_alarm_reply.html
@@ -1 +1,80 @@
-<h2>clock_alarm_reply</h2>\r<hr>\r<p>\r<strong>Function</strong> - Ring a preset alarm.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   clock_alarm_reply</strong>\r                <strong>(reply_port_t</strong>                  <var>alarm_reply_port</var>,\r                 <strong>kern_return_t</strong>                       <var>reply_code</var>,\r                 <strong>alarm_type_t</strong>                        <var>alarm_type</var>,\r                 <strong>tvalspec_t</strong>                           <var>wake_time</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>alarm_reply_port</var> \r<dd>\r[in alarm (receive) right]\rThe reply port named in the corresponding \r<strong>clock_alarm</strong> call.\r<p>\r<dt> <var>reply_code</var> \r<dd>\r[in scalar]\rThe reply status code from the alarm.  The possible values \rare:\r<dl>\r<p>\r<dt> <strong>KERN_SUCCESS</strong>\r<dd>\rThe alarm was delivered without problem.\r<p>\r<dt> <strong>KERN_INVALID_VALUE</strong>\r<dd>\rThe <var>alarm_type</var> and/or <var>alarm_time</var> values supplied to\r<strong>clock_alarm</strong> were invalid.\r<p>\r<dt> <strong>KERN_INVALID_LEDGER</strong>\r<dd>\rThe <var>ledger</var> supplied to <strong>clock_alarm</strong> was not a ledger.\r<p>\r<dt> <strong>KERN_ABORTED</strong>\r<dd>\rThe alarm was terminated via use of <strong>clock_set_time</strong>.\r</dl>\r<p>\r<dt> <var>alarm_type</var> \r<dd>\r[in scalar]\rThe alarm type value supplied to the <strong>clock_alarm</strong> call. \rOnly the low order bits of this value are used by the kernel so the high \rorder bits are available for application use as an alarm identifier.\r<p>\r<dt> <var>wake_time</var> \r<dd>\r[in structure]\rThe time when the alarm message was sent.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rA <strong>clock_alarm_reply</strong> function is called as the result\rof a message from the\rkernel indicating that a previously requested alarm time (<strong>clock_alarm</strong>)\rhas arrived.\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_service.html"><strong>host_get_clock_service</strong></a>,\r<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,\r<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,\r<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,\r<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,\r<a href="clock_reply_server.html"><strong>clock_reply_server</strong></a>,\r<a href="clock_set_time.html"><strong>clock_set_time</strong></a>.\r<p>\rData Structures:\r<a href="tvalspec.html"><strong>tvalspec</strong></a>.\r
\ No newline at end of file
+<h2>clock_alarm_reply</h2>
+<hr>
+<p>
+<strong>Function</strong> - Ring a preset alarm.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   clock_alarm_reply</strong>
+                <strong>(reply_port_t</strong>                  <var>alarm_reply_port</var>,
+                 <strong>kern_return_t</strong>                       <var>reply_code</var>,
+                 <strong>alarm_type_t</strong>                        <var>alarm_type</var>,
+                 <strong>tvalspec_t</strong>                           <var>wake_time</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>alarm_reply_port</var> 
+<dd>
+[in alarm (receive) right]
+The reply port named in the corresponding 
+<strong>clock_alarm</strong> call.
+<p>
+<dt> <var>reply_code</var> 
+<dd>
+[in scalar]
+The reply status code from the alarm.  The possible values 
+are:
+<dl>
+<p>
+<dt> <strong>KERN_SUCCESS</strong>
+<dd>
+The alarm was delivered without problem.
+<p>
+<dt> <strong>KERN_INVALID_VALUE</strong>
+<dd>
+The <var>alarm_type</var> and/or <var>alarm_time</var> values supplied to
+<strong>clock_alarm</strong> were invalid.
+<p>
+<dt> <strong>KERN_INVALID_LEDGER</strong>
+<dd>
+The <var>ledger</var> supplied to <strong>clock_alarm</strong> was not a ledger.
+<p>
+<dt> <strong>KERN_ABORTED</strong>
+<dd>
+The alarm was terminated via use of <strong>clock_set_time</strong>.
+</dl>
+<p>
+<dt> <var>alarm_type</var> 
+<dd>
+[in scalar]
+The alarm type value supplied to the <strong>clock_alarm</strong> call. 
+Only the low order bits of this value are used by the kernel so the high 
+order bits are available for application use as an alarm identifier.
+<p>
+<dt> <var>wake_time</var> 
+<dd>
+[in structure]
+The time when the alarm message was sent.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+A <strong>clock_alarm_reply</strong> function is called as the result
+of a message from the
+kernel indicating that a previously requested alarm time (<strong>clock_alarm</strong>)
+has arrived.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,
+<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,
+<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,
+<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,
+<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,
+<a href="clock_reply_server.html"><strong>clock_reply_server</strong></a>,
+<a href="clock_set_time.html"><strong>clock_set_time</strong></a>.
+<p>
+Data Structures:
+<a href="tvalspec.html"><strong>tvalspec</strong></a>.