1<h2>clock_alarm_reply</h2>
2<hr>
3<p>
4<strong>Function</strong> - Ring a preset alarm.
5<h3>SYNOPSIS</h3>
6<pre>
7<strong>kern_return_t   clock_alarm_reply</strong>
8                <strong>(reply_port_t</strong>                  <var>alarm_reply_port</var>,
9                 <strong>kern_return_t</strong>                       <var>reply_code</var>,
10                 <strong>alarm_type_t</strong>                        <var>alarm_type</var>,
11                 <strong>tvalspec_t</strong>                           <var>wake_time</var><strong>);</strong>
12</pre>
13<h3>PARAMETERS</h3>
14<dl>
15<p>
16<dt> <var>alarm_reply_port</var> 
17<dd>
18[in alarm (receive) right]
19The reply port named in the corresponding 
20<strong>clock_alarm</strong> call.
21<p>
22<dt> <var>reply_code</var> 
23<dd>
24[in scalar]
25The reply status code from the alarm.  The possible values 
26are:
27<dl>
28<p>
29<dt> <strong>KERN_SUCCESS</strong>
30<dd>
31The alarm was delivered without problem.
32<p>
33<dt> <strong>KERN_INVALID_VALUE</strong>
34<dd>
35The <var>alarm_type</var> and/or <var>alarm_time</var> values supplied to
36<strong>clock_alarm</strong> were invalid.
37<p>
38<dt> <strong>KERN_INVALID_LEDGER</strong>
39<dd>
40The <var>ledger</var> supplied to <strong>clock_alarm</strong> was not a ledger.
41<p>
42<dt> <strong>KERN_ABORTED</strong>
43<dd>
44The alarm was terminated via use of <strong>clock_set_time</strong>.
45</dl>
46<p>
47<dt> <var>alarm_type</var> 
48<dd>
49[in scalar]
50The alarm type value supplied to the <strong>clock_alarm</strong> call. 
51Only the low order bits of this value are used by the kernel so the high 
52order bits are available for application use as an alarm identifier.
53<p>
54<dt> <var>wake_time</var> 
55<dd>
56[in structure]
57The time when the alarm message was sent.
58</dl>
59<h3>DESCRIPTION</h3>
60<p>
61A <strong>clock_alarm_reply</strong> function is called as the result
62of a message from the
63kernel indicating that a previously requested alarm time (<strong>clock_alarm</strong>)
64has arrived.
65<h3>RETURN VALUES</h3>
66<p>
67Only generic errors apply.
68<h3>RELATED INFORMATION</h3>
69<p>
70Functions:
71<a href="host_get_clock_service.html"><strong>host_get_clock_service</strong></a>,
72<a href="clock_get_attributes.html"><strong>clock_get_attributes</strong></a>,
73<a href="clock_get_time.html"><strong>clock_get_time</strong></a>,
74<a href="clock_sleep.html"><strong>clock_sleep</strong></a>,
75<a href="clock_alarm.html"><strong>clock_alarm</strong></a>,
76<a href="clock_reply_server.html"><strong>clock_reply_server</strong></a>,
77<a href="clock_set_time.html"><strong>clock_set_time</strong></a>.
78<p>
79Data Structures:
80<a href="tvalspec.html"><strong>tvalspec</strong></a>.
81