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>SetRtcAlarm</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/ptm/Overview.html">ptm</a>::<a href="../../../nn/ptm/CTR/Overview.html">CTR</a>::SetRtcAlarm</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> SetRtcAlarm(
15     <a href="../../../nn/fnd/DateTime/Overview.html">nn::fnd::DateTime</a> datetime
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th>datetime</th>
32<td>Specifies an alarm time</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns the function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></A> values listed below. <br />
37      <table class="arguments">
38        <thead>
39          <tr>
40<th>Value</th>
41<td>Description</td>
42          </tr>
43        </thead>
44        <tr>
45<th><CODE>Result::IsSuccess</CODE></th>
46<td>Process was successful.</td>
47        </tr>
48        <tr>
49<th><CODE>ResultNotRegistered</CODE></th>
50<td>The <a href="../../../nn/ptm/CTR/RegisterAlarmEvent.html"><CODE>nn::ptm::CTR::RegisterAlarmEvent</CODE></a> function has not been called.</td>
51        </tr>
52        <tr>
53<th><CODE>ResultInvalidAlarm</CODE></th>
54<td>The specified date is not in the valid range.</td>
55        </tr>
56        <tr>
57<th><CODE>ResultOverWriteAlarm</CODE></th>
58<td>The alarm has already been set.</td>
59        </tr>
60      </table> </div>
61<h2>Description</h2>
62    <div class="section">
63<p>Sets an alarm.</p><p>
64Specify the time you want to send notification of the alarm; when that time comes, the events registered by <CODE><a href="../../../nn/ptm/CTR/RegisterAlarmEvent.html">nn::ptm::CTR::RegisterAlarmEvent</a></CODE> are signaled.
65            </p><p>
66You can specify any time between 2000/01/01 and 2099/12/31.
67            </p><p>
68Sometimes, there is as much as a one-minute delay past the specified time before the event is signaled. Alternately, the event is sometimes signaled several seconds (roughly 3 seconds) before the specified time.
69            </p><p>
70If you specify a time that has already passed, the event is signaled immediately.
71            </p><p>
72If an alarm has already been set, the function returns <CODE><a href="../../../nn/ptm/CTR/ResultOverWriteAlarm/Overview.html">nn::ptm::CTR::ResultOverWriteAlarm</a></CODE>. The alarm is set successfully even in this case.
73            </p></div>
74<h2>Revision History</h2>
75    <div class="section">
76      <dl class="history">
77        <dt>2011/01/19</dt>
78<dd>Revised explanation of return values.<br />
79        </dd>
80        <dt>2010/12/03</dt>
81<dd>Added information about alarm accuracy.<br />
82        </dd>
83        <dt>2010/09/18</dt>
84<dd>Added restrictions on times for which alarm can be set.<br />
85        </dd>
86        <dt>2010/08/16</dt>
87<dd>Initial version.<br />
88        </dd>
89      </dl>
90    </div>
91  <hr><p>CONFIDENTIAL</p></body>
92</html>
93