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_GetAlarmStatus</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">RTC_GetAlarmStatus <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_GetAlarmStatus(
22            <A href="RTCAlarmChan.html">RTCAlarmChan</A>	chan,
23            <A href="RTCAlarmStatus.html">RTCAlarmStatus</A>*	status );</CODE></PRE>
24  </dd>
25
26</dl><h2>Arguments</h2>
27<TABLE border="1" width="100%">
28  <TBODY>
29    <TR>
30      <TD width="300"><em><strong><font face="Courier New">chan</font></strong></em></TD>
31      <TD width="700">Uses <code><a href="RTCAlarmChan.html">RTCAlarmChan</a></code> to specify the alarm channel.</TD>
32    </TR>
33    <TR>
34      <TD><em><strong><font face="Courier New">status</font></strong></em></TD>
35      <TD>Pointer to <code><a href="RTCAlarmStatus.html">RTCAlarmStatus</a></code> data structure.</TD>
36    </TR>
37  </TBODY>
38</TABLE>
39
40<h2>Return Values</h2>
41<p>If the request succeeds, it returns 0. If the request fails, it returns a numeric value other than 0.</p>
42
43<H2>Description</H2>
44<P>This function reads alarm interrupt permission status from the real time clock. It queries ARM7 for the values of the alarm permission status and returns the results once they are received. This is a synchronous version of the <code><A href="RTC_GetAlarmStatusAsync.html">RTC_GetAlarmStatusAsync</A></code> function.</P>
45
46<h2>Note</h2>
47<P><FONT color=red>This function requires a PXI interrupt for synchronization; do not call it when PXI interrupts are prohibited.</FONT></P>
48
49<h2>See Also</h2>
50<P><code><a href="RTC_GetAlarmStatusAsync.html">RTC_GetAlarmStatusAsync</a>, <a href="RTC_SetAlarmStatus.html">RTC_SetAlarmStatus</a>, <a href="RTC_SetAlarmStatusAsync.html">RTC_SetAlarmStatusAsync</a>, <a href="RTCResult.html">RTCResult</a>, <a href="RTCAlarmChan.html">RTCAlarmChan</a>, <a href="RTCAlarmStatus.html">RTCAlarmStatus</a></code></P>
51
52<H2>Revision History</H2>
53<P>
542005/03/08 Standardized the Japanese term for &quot;interrupt.&quot;<br> 2004/05/18 Initial version.</P>
55<hr><p>CONFIDENTIAL</p></body>
56</html>
57