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=utf-8">
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>OSSetPeriodicAlarm</title>
10</head>
11
12<body>
13
14<h1>OSSetPeriodicAlarm</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/os.h&gt;
19
20typedef void (* OSAlarmHandler ) (OSAlarm* alarm, OSContext* context);
21
22void OSSetPeriodicAlarm(
23        OSAlarm*       alarm,
24        OSTime         start,
25        OSTime         period,
26        OSAlarmHandler handler);
27</pre></dd></dl>
28
29<h2>Arguments</h2>
30<TABLE class="arguments" border="1" >
31  <tr>
32<TH><STRONG><EM><CODE>alarm</CODE></EM></STRONG></TH>
33<TD>Pointer to alarm to set.</TD>
34  </tr>
35  <tr>
36<TH>start</TH>
37<TD>Period origin.</TD>
38  </tr>
39  <tr>
40<TH><STRONG><EM><CODE>period</CODE></EM></STRONG></TH>
41<TD>Ticks for counting each period.</TD>
42  </tr>
43  <tr>
44<TH><STRONG><EM><CODE>handler</CODE></EM></STRONG></TH>
45<TD>Alarm handler to call.</TD>
46  </tr>
47</TABLE>
48
49<h2>Return Values</h2>
50<p>None.</p>
51
52<H2>Description</H2>
53<P>Sets a periodic alarm.</P>
54
55<P>
56<B>Note: </B> If you are going to reset an active alarm that was set by the <CODE>OSSetPeriodicAlarm</CODE> function, call the <CODE><a href="OSCancelAlarm.html">OSCancelAlarm</a></CODE> function and delete that alarm before setting it again. Operations are not guaranteed if you reset an alarm without first deleting it.
57
58
59</P>
60
61<h2>See Also</h2>
62<P class="reference">
63<a target="contents" href="../toc.html#Alarm">Alarm Functions</a><BR> <a href="OSCancelAlarm.html">OSCancelAlarm</a><BR> <a href="OSCreateAlarm.html">OSCreateAlarm</a><BR> <a href="OSSetAlarm.html">OSSetAlarm</a>
64</p>
65
66<H2>Revision History</H2>
67<P>
682009/09/24 Added a note about resetting alarms.<br>2006/03/01 Initial version.<br>
69</P>
70
71<hr><p>CONFIDENTIAL</p></body>
72</html>