1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>SetPeriodic</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/os/Overview.html">os</a>::<a href="../../../nn/os/Alarm/Overview.html">Alarm</a>::SetPeriodic</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/os.h&gt;
14
15void SetPeriodic(
16     <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a> initial,
17     <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a> interval,
18     <a href="../../../nn/os/AlarmHandler.html">AlarmHandler</a> handler,
19     void * param
20);
21</pre>
22    </div>
23<h2>Arguments</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>in</td>
35<th>initial</th>
36<td>Length of time until calling the handler for the first time</td>
37        </tr>
38        <tr>
39<td>in</td>
40<th>interval</th>
41<td>Interval between subsequent calls to the handler, beginning from the second call</td>
42        </tr>
43        <tr>
44<td>in</td>
45<th>handler</th>
46<td>Alarm handler</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th>param</th>
51<td>Parameters to pass to the handler</td>
52        </tr> </table>
53    </div>
54<h2>Return Values</h2>
55    <div class="section">
56None.
57               </div>
58<h2>Description</h2>
59    <div class="section">
60<p>Sets a periodic alarm. Calls the handler once after the <SPAN class="argument">initial</SPAN> duration has elapsed and thereafter continues calling it at the specified <SPAN class="argument">interval</SPAN>.</p><p>
61In the Debug/Development builds, if this function is called while an alarm is set, it will fail on an assertion inside the library. In the Release build, processing with continue without applying the setting.
62            </p></div>
63<h2>Revision History</h2>
64    <div class="section">
65      <dl class="history">
66        <dt>2011/06/22</dt>
67<dd>Described the behavior if called while an alarm is set.<br />
68        </dd>
69        <dt>2010/01/07</dt>
70<dd>Initial version.<br />
71        </dd>
72      </dl>
73    </div>
74  <hr><p>CONFIDENTIAL</p></body>
75</html>
76