# RTC_SetAlarmStatus

## C Specification

  `#include <nitro/rtc.h>`

      RTCResult RTC_SetAlarmStatus(
                  RTCAlarmChan            chan,
                  const RTCAlarmStatus*    status );

## Description

This function writes alarm permission status for the real time clock. It sends a request to ARM7 to allow alarm permissions and returns the process result once it is received. This is a synchronous version of `RTC_SetAlarmStatusAsync`.

## Cautions

Do not define any status values other than `RTC_ALARM_STATUS_OFF` or `RTC_ALARM_STATUS_ON`.

## Arguments

`chan` | Uses `RTCAlarmChan` to specify an alarm channel.
`status` | Pointer to `RTCAlarmStatus` containing status to set.

## Return Values

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

## See Also

`RTC_SetAlarmStatusAsync, RTC_GetAlarmStatus, RTC_GetAlarmParamAsync, RTCResult, RTCAlarmChan, RTCAlarmStatus`

## Revision History

05/18/2004 Initial Version