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