1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.1.0 for Windows">
7<BASE target="main">
8<TITLE>Real Time Clock (RTC) Function List</TITLE>
9<LINK rel="stylesheet" href="../css/apilist.css">
10</HEAD>
11<BODY>
12<H1>Real Time Clock (RTC) Function List</H1>
13<H3><A name="Init">Initialization</A></H3>
14<TABLE border="1" width="100%">
15  <TBODY>
16    <TR>
17<TH width="25%"><A href="RTC_Init.html" target="_self">RTC_Init</A></TH>
18      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
19<TD>Initializes the API.</TD>
20    </TR>
21  </TBODY>
22</TABLE>
23
24<H3><A name="Time">Date, Time</A></H3>
25<TABLE border="1" width="100%">
26  <TBODY>
27    <TR>
28<TH width="25%"><A href="RTC_GetDate.html" target="_self">RTC_GetDate</A></TH>
29      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
30<TD>Gets the date.</TD>
31    </TR>
32    <TR>
33<TH width="25%"><A href="RTC_GetDateAsync.html" target="_self">RTC_GetDateAsync</A></TH>
34      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
35<TD>Asynchronously gets the date.</TD>
36    </TR>
37    <TR>
38<TH width="25%"><A href="RTC_SetDate.html" target="_self">RTC_SetDate</A></TH>
39      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
40<TD>Modifies the date.</TD>
41    </TR>
42    <TR>
43<TH width="25%"><A href="RTC_SetDateAsync.html" target="_self">RTC_SetDateAsync</A></TH>
44      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
45<TD>Asynchronously modifies the date.</TD>
46    </TR>
47    <TR>
48<TH width="25%"><A href="RTC_GetTime.html" target="_self">RTC_GetTime</A></TH>
49      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
50<TD>Gets the time.</TD>
51    </TR>
52    <TR>
53<TH width="25%"><A href="RTC_GetTimeAsync.html" target="_self">RTC_GetTimeAsync</A></TH>
54      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
55<TD>Asynchronously gets the time.</TD>
56    </TR>
57    <TR>
58<TH width="25%"><A href="RTC_SetTime.html" target="_self">RTC_SetTime</A></TH>
59      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
60<TD>Modifies the time.</TD>
61    </TR>
62    <TR>
63<TH width="25%"><A href="RTC_SetTimeAsync.html" target="_self">RTC_SetTimeAsync</A></TH>
64      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
65<TD>Asynchronously modifies the time.</TD>
66    </TR>
67    <TR>
68<TH width="25%"><A href="RTC_GetDateTime.html" target="_self">RTC_GetDateTime</A></TH>
69      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
70<TD>Gets the date and the time.</TD>
71    </TR>
72    <TR>
73<TH width="25%"><A href="RTC_GetDateTimeAsync.html" target="_self">RTC_GetDateTimeAsync</A></TH>
74      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
75<TD>Asynchronously gets the date and the time.</TD>
76    </TR>
77    <TR>
78<TH width="25%"><A href="RTC_SetDateTime.html" target="_self">RTC_SetDateTime</A></TH>
79      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
80<TD>Modifies the date and the time.</TD>
81    </TR>
82    <TR>
83<TH width="25%"><A href="RTC_SetDateTimeAsync.html" target="_self">RTC_SetDateTimeAsync</A></TH>
84      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
85<TD>Asynchronously modifies the date and the time.</TD>
86    </TR>
87  </TBODY>
88</TABLE>
89
90<H3><A name="Alarm">Alarms</A></H3>
91<TABLE border="1" width="100%">
92  <TBODY>
93    <TR>
94<TH width="25%"><A href="RTC_SetAlarmInterrupt.html" target="_self">RTC_SetAlarmInterrupt</A></TH>
95      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
96<TD>Sets the callback function that runs when an alarm interrupt is generated.</TD>
97    </TR>
98    <TR>
99<TH width="25%"><A href="RTC_GetAlarmStatus.html" target="_self">RTC_GetAlarmStatus</A></TH>
100      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
101<TD>Gets alarm interrupt permission status.</TD>
102    </TR>
103    <TR>
104<TH width="25%"><A href="RTC_GetAlarmStatusAsync.html" target="_self">RTC_GetAlarmStatusAsync</A></TH>
105      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
106<TD>Asynchronously gets alarm interrupt permission status.</TD>
107    </TR>
108    <TR>
109<TH width="25%"><A href="RTC_SetAlarmStatus.html" target="_self">RTC_SetAlarmStatus</A></TH>
110      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
111<TD>Modifies alarm interrupt permission status.</TD>
112    </TR>
113    <TR>
114<TH width="25%"><A href="RTC_SetAlarmStatusAsync.html" target="_self">RTC_SetAlarmStatusAsync</A></TH>
115      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
116<TD>Asynchronously modifies alarm interrupt permission status.</TD>
117    </TR>
118    <TR>
119<TH width="25%"><A href="RTC_GetAlarmParam.html" target="_self">RTC_GetAlarmParam</A></TH>
120      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
121<TD>Gets alarm parameter values.</TD>
122    </TR>
123    <TR>
124<TH width="25%"><A href="RTC_GetAlarmParamAsync.html" target="_self">RTC_GetAlarmParamAsync</A></TH>
125      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
126<TD>Asynchronously gets alarm parameter values.</TD>
127    </TR>
128    <TR>
129<TH width="25%"><A href="RTC_SetAlarmParam.html" target="_self">RTC_SetAlarmParam</A></TH>
130      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
131<TD>Modifies alarm parameter values.</TD>
132    </TR>
133    <TR>
134<TH width="25%"><A href="RTC_SetAlarmParamAsync.html" target="_self">RTC_SetAlarmParamAsync</A></TH>
135      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
136<TD>Asynchronously modifies alarm parameter values.</TD>
137    </TR>
138  </TBODY>
139</TABLE>
140
141<H3><A name="Convert">Conversions</A></H3>
142<TABLE border="1" width="100%">
143  <TBODY>
144    <TR>
145<TH width="25%"><A href="RTC_ConvertDateTimeToSecond.html" target="_self">RTC_ConvertDateTimeToSecond</A></TH>
146      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
147<TD>Converts date and time to elapsed seconds since the year 2000.</TD>
148    </TR>
149    <TR>
150<TH width="25%"><A href="RTC_ConvertSecondToDateTime.html" target="_self">RTC_ConvertSecondToDateTime</A></TH>
151      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
152<TD>Converts elapsed seconds since year 2000 to date and time.</TD>
153    </TR>
154    <TR>
155<TH width="25%"><A href="RTC_ConvertDateToDay.html" target="_self">RTC_ConvertDateToDay</A></TH>
156      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
157<TD>Converts the date to elapsed days since the year 2000.</TD>
158    </TR>
159    <TR>
160<TH width="25%"><A href="RTC_ConvertDayToDate.html" target="_self">RTC_ConvertDayToDate</A></TH>
161      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
162<TD>Converts elapsed days since the year 2000 to the date.</TD>
163    </TR>
164    <TR>
165<TH width="25%"><A href="RTC_GetDayOfWeek.html" target="_self">RTC_GetDayOfWeek</A></TH>
166      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
167<TD>Gets the day of the week for the specified date.</TD>
168    </TR>
169  </TBODY>
170</TABLE>
171
172<H3><A name="Convert">Software Clock</A></H3>
173<TABLE border="1" width="100%">
174  <TBODY>
175    <TR>
176<TH width="25%"><A href="RTC_InitSWClock.html" target="_self">RTC_InitSWClock</A></TH>
177      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
178<TD>Initializes the software clock.</TD>
179    </TR>
180    <TR>
181<TH width="25%"><A href="RTC_SyncSWClock.html" target="_self">RTC_SyncSWClock</A></TH>
182      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
183<TD>Synchronizes the software clock with the real-time clock.</TD>
184    </TR>
185    <TR>
186<TH width="25%"><A href="RTC_GetSWClockTick.html" target="_self">RTC_GetSWClockTick</A></TH>
187      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
188<TD>Gets the total number of ticks that have elapsed since 2000 from the software clock.</TD>
189    </TR>
190    <TR>
191<TH width="25%"><A href="RTC_GetDateTimeExFromSWClock.html" target="_self">RTC_GetDateTimeExFromSWClock</A></TH>
192      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
193<TD>Gets the date and time from the software clock.</TD>
194    </TR>
195    <TR>
196<TH width="25%"><A href="RTC_GetLastSyncSWClockResult.html" target="_self">RTC_GetLastSyncSWClockResult</A></TH>
197      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
198<TD>Gets errors when synchronizing the software and real-time clock.</TD>
199    </TR>
200  </TBODY>
201</TABLE>
202
203<H3><A name="Type">Types and Structures</A></H3>
204<TABLE border="1" width="100%">
205  <TBODY>
206    <TR>
207<TH width="25%"><A href="RTCDate.html" target="_self">RTCDate</A></TH>
208      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
209<TD>Date structure.</TD>
210    </TR>
211    <TR>
212<TH width="25%"><A href="RTCWeek.html" target="_self">RTCWeek</A></TH>
213      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
214<TD>Day of the week enumeration.</TD>
215    </TR>
216    <TR>
217<TH width="25%"><A href="RTCTime.html" target="_self">RTCTime</A></TH>
218      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
219<TD>Time structure.</TD>
220    </TR>
221    <TR>
222<TH width="25%"><A href="RTCTimeEx.html" target="_self">RTCTimeEx</A></TH>
223      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
224<TD>Extended time structure</TD>
225    </TR>
226    <TR>
227<TH width="25%"><A href="RTCAlarmChan.html" target="_self">RTCAlarmChan</A></TH>
228      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
229<TD>Alarm channel enumeration.</TD>
230    </TR>
231    <TR>
232<TH width="25%"><A href="RTCAlarmStatus.html" target="_self">RTCAlarmStatus</A></TH>
233      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
234<TD>RTC alarm interrupt permission status enumeration.</TD>
235    </TR>
236    <TR>
237<TH width="25%"><A href="RTCAlarmParam.html" target="_self">RTCAlarmParam</A></TH>
238      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
239<TD>Alarm parameter structure.</TD>
240    </TR>
241    <TR>
242<TH width="25%"><A href="RTCCallback.html" target="_self">RTCCallback</A></TH>
243      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
244<TD>Callback function type for asynchronous functions.</TD>
245    </TR>
246    <TR>
247<TH width="25%"><A href="RTCInterrupt.html" target="_self">RTCInterrupt</A></TH>
248      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
249<TD>Callback function type for RTC alarm interrupts.</TD>
250    </TR>
251    <TR>
252<TH width="25%"><A href="RTCResult.html" target="_self">RTCResult</A></TH>
253      <TD width="60"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD>
254<TD>Enumeration of the process results that are common to the RTC function group.</TD>
255    </TR>
256  </TBODY>
257</TABLE>
258
259<table border="0" height="100%"><tr><td style="background-color : white;"></td></tr></table>
260
261<hr><p>CONFIDENTIAL</p></body>
262</HTML>