# RTCAlarmStatus

## Definitions

  `#include <nitro/rtc.h>`

      typedef enum
      {
          RTC_ALARM_STATUS_OFF = 0,
          RTC_ALARM_STATUS_ON,
          RTC_ALARM_STATUS_MAX

      } RTCAlarmStatus;

## Description

This enum describes the status of the alarms that can be registered in the real time clock.
If alarm interrupts are permitted, the alarm parameter value and the current value will be compared each time there is a process to increment minutes. If they match, an interrupt will be generated.
If interrupts are prohibited, you can not read or write alarm parameter values.

## Elements

RTC_ALARM_STATUS_OFF | Alarm interrupt prohibited
RTC_ALARM_STATUS_ON | Alarm interrupt permitted

## See Also

`RTCAlarmParam`

## Revision History

05/18/2004 Initial Version