RTC_GetDate


C Specification

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

Description

This function reads date data from the real time clock. It queries ARM7 for date data and returns the information once it is received. This is a synchronous version of RTC_GetDateAsync.

Cautions

This function requires a PXI interrupt for synchronization. It cannot be used in situations where PXI interrupts are prohibited. The RTC alarm interrupt permission status must be "enable" for this function to work properly with the real time clock. If the status is not "enable," the function returns an error.

Arguments

date Pointer to RTCDate where date information will be stored.

Return Values

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

See Also

RTC_GetDateAsync, RTC_SetDate, RTC_SetDateAsync, RTCResult, RTCDate

Revision History

05/18/2004 Initial Version