# RTC_SetAlarmParam

## 構文

  `#include <nitro/rtc.h>`

      RTCResult RTC_SetAlarmParam(
                  RTCAlarmChan		chan,
                  const RTCAlarmParam*	param );

## 引数

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

## 返り値

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

## 説明

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

## 注意

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

## 参照

`RTC_SetAlarmParamAsync, RTC_GetAlarmParam, RTC_GetAlarmParamAsync, RTCResult, RTCAlarmChan, RTCAlarmParam`

## 履歴

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