Skip to content
Michael Miller edited this page Jul 6, 2023 · 1 revision

The AlarmAddError represents the error returned from the AddAlarm() method if it returns a negative value.

enum AlarmAddError
{
    AlarmAddError_PeriodInvalid = -4,
    AlarmAddError_TimePast,    // -3
    AlarmAddError_TimeInvalid, // -2
    AlarmAddError_CountExceeded, // -1
};

AlarmAddError_PeriodInvalid

The given alarm period is invalid. It is neither a AlarmPeriod enum value nor a valid custom period. Custom periods must be greater than 60 seconds.

AlarmAddError_TimePast

The given date and time for a single fire alarm is in the past and would never have been triggered. Reoccurring alarms will never return this as they will automatically increment by the period to the next date and time that has not passed.

AlarmAddError_TimeInvalid

The given date and time value is not valid. This can be caused by any date and time member (year/month/day/hour/minute/second) being out of normal time value or the date and time do not represent a valid day like a leap day in a non-leap year.

AlarmAddError_CountExceeded

The RtcAlarmManager maximum active alarms has been exceeded. Increase the max count defined for your instance at construction or reduce your use of active alarms.

Clone this wiki locally