# RTC_GetAlarmStatus

## C Specification

  `#include <nitro/rtc.h>`

      RTCResult RTC_GetAlarmStatus(
      RTCAlarmChan	chan,
      RTCAlarmStatus*	status );

## Arguments

chan | Uses `RTCAlarmChan` to specify the alarm channel.
status | Pointer to `RTCAlarmStatus` data structure.

## Return Values

If the request succeeds, it returns 0. If the request fails, it returns some numeric value other than 0.

## Description

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 `RTC_GetAlarmStatusAsync`.

## Caution

This function requires a PXI interrupt for synchronization. Do not call this function when PXI interrupts are prohibited.

## See Also

`RTC_GetAlarmStatusAsync, RTC_SetAlarmStatus, RTC_SetAlarmStatusAsync, RTCResult, RTCAlarmChan, RTCAlarmStatus`

## Revision History

03/08/2005 Standardized the Japanese term for "interrupt"
05/18/2004 Initial version

CONFIDENTIAL