15.6.3.2.6 Function rtc_calendar_get_alarm()
Get the current alarm time of specified alarm.
enum status_code rtc_calendar_get_alarm( struct rtc_module *const module, struct rtc_calendar_alarm_time *const alarm, const enum rtc_calendar_alarm alarm_index)
Retrieves the current alarm time for the alarm specified.
| Data direction | Parameter name | Description |
|---|---|---|
|
[in, out] |
module |
Pointer to the software instance struct |
|
[out] |
alarm |
Pointer to the struct that will be filled with alarm time and mask of the specified alarm |
|
[in] |
alarm_index |
Index of alarm to get alarm time from |
Returns
Status of getting alarm.
| Return value | Description |
|---|---|
|
STATUS_OK |
If alarm was read correctly |
|
STATUS_ERR_INVALID_ARG |
If invalid argument(s) were provided |