1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>OSSetAlarm</title>
10</head>
11
12<body>
13
14<h1>OSSetAlarm</h1>
15
16
17<h2>C Specification</h2>
18
19<dl>
20<dd><pre><code>#include &lt;revolution/os.h&gt;
21
22typedef void (* OSAlarmHandler )(OSAlarm* alarm, OSContext* context);
23
24void OSSetAlarm (OSAlarm*       alarm,
25OSTime         tick,
26OSAlarmHandler handler);</code></pre>
27</dl>
28
29<h2>Arguments</h2>
30<TABLE border="1" cellpadding="3" cellspacing="0.1">
31  <tr>
32<TD width="120" bgcolor="#ffffe8"><i><b><code><STRONG><EM><CODE>alarm</CODE></EM></STRONG></code></b></i></TD>
33<TD width="520">Pointer to alarm to set.</TD>
34    </tr>
35  <tr>
36<TD width="120" bgcolor="#ffffe8"><i><b><code><STRONG><EM><CODE>tick</CODE></EM></STRONG></code></b></i></TD>
37<TD width="520">Tick count before firing.</TD>
38    </tr>
39  <tr>
40<TD width="120" bgcolor="#ffffe8"><i><b><code><STRONG><EM><CODE>handler</CODE></EM></STRONG></code></b></i></TD>
41<TD width="520">Alarm handler to call.</TD>
42    </tr>
43</TABLE>
44<h2>Return Values</h2>
45
46<p>None.</p>
47<H2>Description</H2>
48<P>Sets a one time alarm.</P>
49
50
51
52<h2>See Also</h2>
53
54<p>
55<a target="contents" href="../toc.html#Alarm">Alarm Functions</a>, <code><a href="OSCancelAlarm.html">OSCancelAlarm</a></code>, <code><a href="OSCreateAlarm.html">OSCreateAlarm</a></code>,&nbsp; <code><a href="OSSetPeriodicAlarm.html">OSSetPeriodicAlarm</a></code>
56</p>
57
58<H2>Revision History</H2>
59<P>03/01/2006 Initial version.</P>
60</body>
61</html>