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=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>RTC_GetTimeAsync</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">RTC_GetTimeAsync <img src="../image/NTR.gif" align="middle"><img src="../image/TWL.gif" align="middle"></h1>
15
16<h2>Syntax</h2>
17
18<dl>
19  <dd>
20<CODE>#include &lt;nitro/rtc.h&gt;</CODE><BR>
21  <PRE><CODE><A href="RTCResult.html">RTCResult</A> RTC_GetTimeAsync(
22            <A href="RTCTime.html">RTCTime</A>*    time,
23            <A href="RTCCallback.html">RTCCallback</A> callback,
24            void*       arg );</CODE></PRE>
25  </dd>
26
27</dl><h2>Arguments</h2>
28<TABLE border="1" width="100%">
29  <TBODY>
30    <TR>
31      <TD width="300"><em><strong><font face="Courier New">time</font></strong></em></TD>
32      <TD width="700">Pointer to the buffer where time information will be stored.</TD>
33    </TR>
34    <TR>
35      <TD><em><strong><font face="Courier New">callback</font></strong></em></TD>
36      <TD>Pointer to the callback function. This callback is called from within the interrupt handler.</TD>
37    </TR>
38    <TR>
39      <TD><em><strong><font face="Courier New">arg</font></strong></em></TD>
40      <TD>Argument to pass to the callback function.</TD>
41    </TR>
42  </TBODY>
43</TABLE>
44
45<h2>Return Values</h2>
46<p>If the request succeeds, it returns 0. If the request fails, it returns a numeric value other than 0.</p>
47
48<H2>Description</H2>
49<P>This function asynchronously reads time data from the real-time clock. It queries ARM7 for time data and returns those values without waiting for a response from the processor. To get the result from the processor, you must use the <em><strong><code>result</code></strong></em> argument. If this function fails, no operation is performed and no user callback function is called.</P>
50
51<h2>Note</h2>
52<P>Values are written to the <code>RTCTime</code> specified by the <code><em><strong>time</strong></em></code> argument asynchronously with respect to the function. Do not use this variable for anything else until a user callback function confirms the completion of this asynchronous operation.</P>
53
54<h2>See Also</h2>
55<P><code><a href="RTC_GetTime.html">RTC_GetTime</a>, <a href="RTC_SetTime.html">RTC_SetTime</a>, <a href="RTC_SetTimeAsync.html">RTC_SetTimeAsync</a>, <a href="RTCResult.html">RTCResult</a>, <a href="RTCTime.html">RTCTime</a>, <a href="RTCCallback.html">RTCCallback</a></code></P>
56
57<H2>Revision History</H2>
58<P>
592005/06/27 Added text indicating that the callback is invoked from the interrupt handler. <br>2004/05/18 Initial version.</P>
60<hr><p>CONFIDENTIAL</p></body>
61</html>
62