RTC_SetDate


C Specification

#include <nitro/rtc.h>
RTCResult RTC_SetDate( const RTCDate*  date );

Description

This function writes date data to the real time clock. It sends date data to ARM7 and returns the process result once it is received. This is a synchronous version of RTC_SetDateAsync.

Cautions

Do not define 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. This function requires a PXI interrupt for synchronization. It cannot be used in situations where PXI interrupts are prohibited. Because applications cannot change the date, use this API only for debugging during development.

Arguments

date Pointer to RTCDate containing date information to be set.

Return Values

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

See Also

RTC_SetDateAsync, RTC_GetDate, RTC_GetDateAsync, RTCResult, RTCDate

Revision History

05/18/2004 Initial Version