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_SetTime</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">RTC_SetTime <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_SetTime( const <A href="RTCTime.html">RTCTime</A>* time );</CODE></PRE>
22  </dd>
23
24</dl><h2>Arguments</h2>
25<TABLE border="1" width="100%">
26  <TBODY>
27    <TR>
28<TD width="300"><em><strong><font face="Courier New">time</font></strong></em></TD>
29<TD width="700">Pointer to the buffer storing time data.</TD>
30    </TR>
31  </TBODY>
32</TABLE>
33
34<h2>Return Values</h2>
35<p>If the request succeeds, it returns 0. If the request fails, it returns a numeric value other than 0.</p>
36
37<H2>Description</H2>
38<P>This function writes time data to the real-time clock. It sends time data to ARM7 and returns the process result once it is received. This is a synchronous version of the <code><A href="RTC_SetTimeAsync.html">RTC_SetTimeAsync</A></code> function.</P>
39
40<h2>Note</h2>
41<P><FONT color=red>Do not define parameter values of nonexistent times.<BR> This function requires a PXI interrupt for synchronization. Do not call this function when PXI interrupts are prohibited.</FONT><BR> <FONT color=red>Because applications cannot change the date, use this API only for debugging during development.<br /> In FINALROM builds, this function always fails and <CODE>RTC_RESULT_INVALID_COMMAND</CODE> is returned.</FONT></P>
42
43<h2>See Also</h2>
44<P><code><a href="RTC_SetTimeAsync.html">RTC_SetTimeAsync</a><br> <a href="RTC_GetTime.html">RTC_GetTime</a><br> <a href="RTC_GetTimeAsync.html">RTC_GetTimeAsync</a><br> <a href="RTCResult.html">RTCResult</a><br> <a href="RTCTime.html">RTCTime</a></code></P>
45
46<H2>Revision History</H2>
47<P>
482009/07/29 Explained that the time setting command always fails in FINALROM builds.<br /> 2005/03/08 Standardized the Japanese term for <I>interrupt</I>. <br>2004/07/01 Changed the description to standardize the time notation. <BR>2004/05/18 Initial version.<BR></P>
49<hr><p>CONFIDENTIAL</p></body>
50</html>
51