RTC_SetAlarmStatusAsync


C Specification

#include <nitro/rtc.h>
RTCResult RTC_SetAlarmStatusAsync( 
            RTCAlarmChan            chan,
            const RTCAlarmStatus*   status,
            RTCCallback             callback,
            void*                   arg );

Description

This function asynchronously writes alarm permission status for the real time clock. It sends a request to ARM7 to allow alarm permissions and returns the process result without waiting for a response from the processor. To get the actual process result from the processor, you must use the RTCResult upon return.

If this function fails, no operation is performed and no user callback function is called.

Cautions

In write alarm state, do not set to any state other than enable or prohibit.

Values are written to the variable specified by the status argument asynchronously. Do not use this variable for anything else until a user callback function confirms the completion of this operation.

Arguments

chan Uses RTCAlarmChan to specify an alarm channel.
status Pointer to RTCAlarmStatus containing status to set.
callback Pointer to specific RTCCallback function to be used.
arg User context.

Return Values

If the request succeeds, it returns 0.
If the request fails, it returns some numeric value other than 0.

See Also

RTC_SetAlarmStatus, RTC_GetAlarmStatus, RTC_GetAlarmStatusAsync, RTCResult, RTCAlarmChan, RTCAlarmStatus, RTCCallback

Revision History

05/18/2004 Initial Version