RTC_GetDateAsync

C Specification

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

Arguments

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

Description

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

See Also

RTC_GetDate, RTC_SetDate, RTC_SetDateAsync, RTCResult, RTCDate, RTCCallback

Revision History

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