HAL_RTC_GetDate() function

Gets RTC current date.

Syntax

from stm32f4xx_hal_rtc.h:716

HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);

Implemented in stm32f4xx_hal_rtc.c:946

Arguments

hrtc

pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

sDate

Pointer to Date structure

Format

Specifies the format of the entered parameters. This parameter can be one of the following values: @arg RTC_FORMAT_BIN: Binary data format @arg RTC_FORMAT_BCD: BCD data format

Return value

HAL status

Notes

You must call HAL_RTC_GetDate() after HAL_RTC_GetTime() to unlock the values in the higher-order calendar shadow registers to ensure consistency between the time and date values. Reading RTC current time locks the values in calendar shadow registers until current date is read to ensure consistency between the time and date values.

Examples

HAL_RTC_GetDate() is referenced by 38 libraries and example projects.

References

Location	Text
stm32f4xx_hal_rtc.c:946	HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef hrtc, RTC_DateTypeDef sDate, uint32_t Format)
stm32f4xx_hal_rtc.h:716	HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef hrtc, RTC_DateTypeDef sDate, uint32_t Format);