15.6.3.3.6 Function rtc_calendar_clear_alarm_match()
Clears the RTC alarm match flag.
enum status_code rtc_calendar_clear_alarm_match( struct rtc_module *const module, const enum rtc_calendar_alarm alarm_index)
Clear the requested alarm match flag, so that future alarm matches can be determined.
| Data direction | Parameter name | Description |
|---|---|---|
|
[in, out] |
module |
Pointer to the software instance struct |
|
[in] |
alarm_index |
The index of the alarm match to clear |
Returns
Status of the alarm match clear operation.
| Return value | Description |
|---|---|
|
STATUS_OK |
If flag was cleared correctly |
|
STATUS_ERR_INVALID_ARG |
If invalid argument(s) were provided |