RTC_GetDateTimeAsync

C Specification

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

Arguments

date Pointer to RTCDate, where date information will be stored.
time Pointer to RTCTime, where time information will be stored.
callback Pointer to the callback function. This callback is called from within the interrupt handler.
arg Argument to pass 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.

Description

This function asynchronously reads date and time data from the real time clock. It queries ARM7 for date and time data 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.

Caution

Values are written to the variables specified by the date and time arguments asynchronously with respect to the function. Do not use these variables for anything else until a user callback function confirms the completion of this asynchronous operation.

See Also

RTC_GetDateTime, RTC_SetDateTime, RTC_SetDateTimeAsync, RTCResult, RTCDate, RTCTime, RTCCallback

Revision History

06/27/2005 Added additional text indicating that the callback is called from the interrupt handler.
05/18/2004 Initial version