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_SetDateAsync</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">RTC_SetDateAsync <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_SetDateAsync(
22            const <A href="RTCDate.html">RTCDate</A>*    date,
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">date</font></strong></em></TD>
32<TD width="700">Pointer to the buffer storing date data.</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 writes date data to the real-time clock. It sends date data to ARM7 and returns the process result 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><FONT color=red>Do not define parameter values of nonexistent years, months, or days. However, you may specify a day of the week that does not match the actual calendar. Values are written to the variable specified by the <SPAN class="argument">date</SPAN> argument asynchronously with respect to this function. Do not use this variable for anything else until a user callback function confirms the completion of this asynchronous operation.</FONT><BR><FONT color=red>Because applications cannot change the date, use this function only for debugging during development.<br /> In FINALROM builds, this function always fails and <CODE>RTC_RESULT_INVALID_COMMAND</CODE> is returned.</FONT></P>
53
54<h2>See Also</h2>
55<P><code><a href="RTC_SetDate.html">RTC_SetDate</a><br /> <a href="RTC_GetDate.html">RTC_GetDate</a><br /> <a href="RTC_GetDateAsync.html">RTC_GetDateAsync</a><br /> <a href="RTCResult.html">RTCResult</a><br /> <a href="RTCDate.html">RTCDate</a><br /> <a href="RTCCallback.html">RTCCallback</a></code></P>
56
57<H2>Revision History</H2>
58<P>
592009/07/29 Explained that the time setting command always fails in FINALROM builds.<br /> 2005/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