From 58fe3a8e4b81863a84aa0dabc4d543052f1c1bdb Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Thu, 6 Jul 2023 08:56:45 -0700 Subject: [PATCH] Created enum AlarmAddError (markdown) --- enum-AlarmAddError.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 enum-AlarmAddError.md diff --git a/enum-AlarmAddError.md b/enum-AlarmAddError.md new file mode 100644 index 0000000..6fb102e --- /dev/null +++ b/enum-AlarmAddError.md @@ -0,0 +1,23 @@ +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. \ No newline at end of file