RTC_SetDateTime


C Specification

#include <nitro/rtc.h>
RTCResult RTC_SetDateTime( 
            const RTCDate* date,
            const RTCTime* time );

Description

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

Cautions

Do not define parameter values of nonexistent dates or times. 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 set.
time Pointer to RTCTime containing time information to 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_SetDateTimeAsync, RTC_GetDateTime, RTC_GetDateTimeAsync, RTCResult, RTCDate, RTCTime

Revision History

07/01/2004 Changed the description to standardize the time notation.
05/18/2004 Initial Version