# RTC_SetAlarmStatus

## C Specification

  `#include <nitro/rtc.h>`

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

## Arguments

chan | Uses `RTCAlarmChan` to specify the 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.

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

## Caution

In write alarm state, do not set to any state other than enable or prohibit.
This function requires a PXI interrupt for synchronization. Do not call this function when PXI interrupts are prohibited.

## See Also

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

## Revision History

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

CONFIDENTIAL