RTC_GetTimeAsync


C Specification

#include <nitro/rtc.h>
RTCResult RTC_GetTimeAsync( 
            RTCTime*    time,
            RTCCallback callback,
            void*       arg );

Description

This function asynchronously reads time data from the real time clock. It queries ARM7 for time data and returns those values without waiting for a response from the processor. To get the actual time information from the processor, you must use the result argument.

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

Cautions

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

Arguments

time Pointer to RTCTime where time information will be stored.
callback Pointer to specific RTCCallback function to be used.
arg The argument to be passed to the Callback function.

Return Values

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

See Also

RTC_GetTime, RTC_SetTime, RTC_SetTimeAsync, RTCResult, RTCTime, RTCCallback

Revision History

05/18/2004 Initial Version