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_SetAlarmStatusAsync</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">RTC_SetAlarmStatusAsync <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_SetAlarmStatusAsync(
22            <A href="RTCAlarmChan.html">RTCAlarmChan</A>	        chan,
23            const <A href="RTCAlarmStatus.html">RTCAlarmStatus</A>*	status,
24            <A href="RTCCallback.html">RTCCallback</A>			callback,
25            void*			arg );</CODE></PRE>
26  </dd>
27
28</dl><h2>Arguments</h2>
29<TABLE border="1" width="100%">
30  <TBODY>
31    <TR>
32      <TD width="300"><em><strong><font face="Courier New">chan</font></strong></em></TD>
33      <TD width="700">Uses <code><a href="RTCAlarmChan.html">RTCAlarmChan</a></code> to specify the alarm channel.</TD>
34    </TR>
35    <TR>
36      <TD><em><strong><font face="Courier New">status</font></strong></em></TD>
37      <TD>Pointer to <code><a href="RTCAlarmStatus.html">RTCAlarmStatus</a></code> containing status to set.</TD>
38    </TR>
39    <TR>
40      <TD><em><strong><font face="Courier New">callback</font></strong></em></TD>
41      <TD>Pointer to the callback function. This callback is called from within the interrupt handler.</TD>
42    </TR>
43    <TR>
44      <TD><em><strong><font face="Courier New">arg</font></strong></em></TD>
45      <TD>Argument to pass to the callback function.</TD>
46    </TR>
47  </TBODY>
48</TABLE>
49
50<h2>Return Values</h2>
51<p>If the request succeeds, it returns 0. If the request fails, it returns a numeric value other than 0.</p>
52
53<H2>Description</H2>
54<P>This function asynchronously writes alarm permission status for the real-time clock. It sends a request to ARM7 to allow alarm permissions 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>
55
56<h2>Note</h2>
57<P><FONT color=red>In write alarm state, do not set to any state other than <strong>enable</strong> or <strong>prohibit</strong>. Values are written to the variable specified by the <CODE>status</CODE> argument asynchronously. Do not use this variable for anything else until a user callback function confirms the completion of this operation.</FONT></P>
58
59<h2>See Also</h2>
60<P><code><a href="RTC_SetAlarmStatus.html">RTC_SetAlarmStatus</a>, <a href="RTC_GetAlarmStatus.html">RTC_GetAlarmStatus</a>, <a href="RTC_GetAlarmStatusAsync.html">RTC_GetAlarmStatusAsync</a>, <a href="RTCResult.html">RTCResult</a>, <a href="RTCAlarmChan.html">RTCAlarmChan</a>, <a href="RTCAlarmStatus.html">RTCAlarmStatus</a>, <a href="RTCCallback.html">RTCCallback</a></code></P>
61
62<H2>Revision History</H2>
63<P>
642005/06/27 Added a statement about callbacks being invoked from the interrupt handler. <br>2005/03/08 Standardized use of the term &quot;interrupt&quot; in Japanese. <br>2004/05/18 Initial version.</P>
65<hr><p>CONFIDENTIAL</p></body>
66</html>
67