RTC_SetAlarmParam

C Specification

#include <nitro/rtc.h>
RTCResult RTC_SetAlarmParam( 
RTCAlarmChan	chan, 
const RTCAlarmParam*	param );

Arguments

chan Uses RTCAlarmChan to specify the alarm channel.
param Pointer to RTCAlarmParam containing parameters 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 interrupt parameter values to the real time clock. It sends alarm interrupt data to ARM7 and returns the process result once it is received. This is a synchronous version of RTC_SetAlarmParamAsync.

Caution

Do not define parameter values of nonexistent days of the week or times.
Unless the RTC alarm interrupt permission status is "enable," it is not possible to write parameter values to the real time clock, causing any attempted call of this function to fail.
This function requires a PXI interrupt for synchronization. Do not call this function when PXI interrupts are prohibited.

See Also

RTC_SetAlarmParamAsync, RTC_GetAlarmParam, RTC_GetAlarmParamAsync, RTCResult, RTCAlarmChan, RTCAlarmParam

Revision History

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