# RTC_GetAlarmParam

## C Specification

  `#include <nitro/rtc.h>`

      RTCResult RTC_GetAlarmParam(
      RTCAlarmChan	chan,
      RTCAlarmParam*	param );

## Arguments

chan | Uses `RTCAlarmChan` to specify the alarm channel.
param | Pointer to `RTCAlarmParam`.

## 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 the alarm interrupt parameter values from the real time clock. It queries ARM7 for the values of the alarm interrupt parameter and returns those values once they are received. This is a synchronous version of `RTC_GetAlarmParamAsync.`

## Caution

This function requires a PXI interrupt for synchronization. It cannot be used in situations where PXI interrupts are prohibited.
The RTC alarm interrupt enable status must be "enable" for this function to work properly with the real time clock. If the status is not "enable," the function returns an error.

## See Also

`RTC_GetAlarmParamAsync, RTC_SetAlarmParam, RTC_SetAlarmParamAsync, RTCResult, RTCAlarmChan, RTCAlarmParam`

## Revision History

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