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>GetRtcAlarm</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>::GetRtcAlarm</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> GetRtcAlarm(
15     <a href="../../../nn/fnd/DateTime/Overview.html">nn::fnd::DateTime</a> * pDatetime
16);
17</pre>
18    </div>
19<h2>Parameters</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>out</td>
31<th>pDatetime</th>
32<td>Specifies the address where the obtained time should be placed.</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 /> <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>ResultNoAlarm</CODE></th>
50<td>An alarm has not been configured.</td>
51        </tr>
52      </table> </div>
53<h2>Description</h2>
54    <div class="section">
55<p>Gets the time for which the alarm has been set.</p><p>If notification of the time has been sent already, or if an alarm has not been configured, the function returns <CODE><a href="../../../nn/ptm/ResultNoAlarm/Overview.html">ResultNoAlarm</a></CODE>. In these cases, no value is placed in <SPAN class="argument">pDatetime</SPAN>.</p><!-- write here --></div>
56<h2>Revision History</h2>
57    <div class="section">
58      <dl class="history">
59        <dt>2010/08/16</dt>
60<dd>Initial version.<br />
61        </dd>
62      </dl>
63    </div>
64  <hr><p>CONFIDENTIAL</p></body>
65</html>