RTC_SetDateAsync


C Specification

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

Description

This function asynchronously writes date data to the real time clock. It sends date data to ARM7 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

Do not define parameter values of nonexistent years, months, or days. However, you may specify a day of the week that does not match the actual calendar.

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.

Because applications cannot change the date, use this API only for debugging during development.

Arguments

date Pointer to RTCDate containing date information to set.
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_SetDate, RTC_GetDate, RTC_GetDateAsync, RTCResult, RTCDate, RTCCallback

Revision History

05/18/2004 Initial Version