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>SetOneShot</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>::SetOneShot</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13<pre class="definition">#include &lt;nn/os.h&gt;
14void SetOneShot(
15     <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a> time,
16     <a href="../../../nn/os/AlarmHandler.html">AlarmHandler</a> handler,
17     void * param
18);
19</pre>
20    </div>
21<h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>in</td>
33<th>time</th>
34<td>How long to wait until calling the handler (ns).</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>handler</th>
39<td>Alarm handler.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>param</th>
44<td>Parameters to pass to the handler.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48    <div class="section">
49None.
50               </div>
51<h2>Description</h2>
52    <div class="section">
53<p>Sets a one-shot alarm. Calls the handler only once after the specified <SPAN class="argument">time</SPAN> has elapsed.</p><p>
54In 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.
55            </p></div>
56<h2>Revision History</h2>
57    <div class="section">
58      <dl class="history">
59        <dt>2011/06/22</dt>
60<dd>Described the behavior if called while an alarm is set.<br />
61        </dd>
62        <dt>2010/01/07</dt>
63<dd>Initial version.<br />
64        </dd>
65      </dl>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>
69