# RTC_GetAlarmParam

## 構文

  `#include <nitro/rtc.h>`

      RTCResult RTC_GetAlarmParam(
                  RTCAlarmChan	chan,
                  RTCAlarmParam*	param );

## 引数

chan | アラームチャンネルをRTCAlarmChan列挙型で指定します。
param | アラーム設定値を受け取るRTCAlarmParam型のバッファへのポインタ

## 返り値

要求が成功した場合に 0 を返します。
要求が失敗した場合には 0 以外を返します。

## 説明

リアルタイムクロックからアラーム割り込み設定値を読み出します。
この関数はARM7にアラーム割り込み設定値読み出し要求を発行し、ARM7からの応答を待って処理結果を返します。
`RTC_GetAlarmParamAsync()` の同期版です。

## 注意

この関数は同期を取る為にPXI割り込みを待ちますので、PXI割り込みを禁止した状態で呼び出さないようにして下さい。
また、RTCアラーム割り込み許可状態が"許可"でない場合はリアルタイムクロックから設定値を読み出すことはできませんので、この関数は失敗します。

## 参照

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

## 履歴

2005/03/08 用語統一 [割込み] → [割り込み]
2004/05/18 初版