RTC_SetDate

Syntax

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

Arguments

date Pointer to the buffer storing date data.

Return Values

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

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 the RTC_SetDateAsync function.

Note

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. 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 function only for debugging during development.
In FINALROM builds, this function always fails and RTC_RESULT_INVALID_COMMAND is returned.

See Also

RTC_SetDateAsync
RTC_GetDate
RTC_GetDateAsync
RTCResult
RTCDate

Revision History

2009/07/29 Explained that the time setting command always fails in FINALROM builds.
2005/03/08 Standardized the Japanese term for interrupt.
2004/05/18 Initial version.


CONFIDENTIAL