HAL_RTC_SetAlarm() - syntax, references, call tree, description

hrtc

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

sAlarm

Pointer to Alarm 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

Notes

The Alarm register can only be written when the corresponding Alarm is disabled (Use the HAL_RTC_DeactivateAlarm()). The HAL_RTC_SetTime() must be called before enabling the Alarm feature.

References

Location	Text
stm32f4xx_hal_rtc.c:1004	HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef hrtc, RTC_AlarmTypeDef sAlarm, uint32_t Format)
stm32f4xx_hal_rtc.h:725	HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef hrtc, RTC_AlarmTypeDef sAlarm, uint32_t Format);