#include <nitro/rtc.h>
RTCResult RTC_GetAlarmParamAsync(
RTCAlarmChan chan,
RTCAlarmParam* param,
RTCCallback callback,
void* arg );
chan | Uses RTCAlarmChan enum type to specify the alarm channel. |
param | Pointer to RTCAlarmParam . |
callback | Pointer to the callback function This callback is called from within the interrupt handler. |
arg | Argument passed to the callback function. |
If the request succeeds, it returns 0. If the request fails, it returns some numeric value other than 0.
This function asynchronously reads the alarm interrupt parameter values from the real time clock. It queries ARM7 for the values of the alarm interrupt parameters and returns those values without waiting for a response from the processor. To get the result from the processor, you must use the result
argument. If this function fails, no operation is performed and no user callback function is called.
If the RTC alarm interrupt permission status is not "permit," the function will not be able to read the parameter values from the real-time clock. Therefore, even if this function succeeds, a "process failed" result will be passed to the user callback function. Also, the value is written asynchronously to the buffer specified with the param
argument, so do not use this for other purpose until the completion of the asynchronous process is confirmed with the user callback function.
RTC_GetAlarmParamAsync, RTC_SetAlarmParam, RTC_SetAlarmParamAsync, RTCResult, RTCAlarmChan, RTCAlarmParam, RTCCallback
06/27/2005 Added statement about callback being called from the interrupt handler.
03/08/2005 Standardized the use of the term 'interrupt' in Japanese.
05/18/2004 Initial version