[][src]Type Definition rpi_pico_sdk::alarm_id_t

type alarm_id_t = i32;

\brief The identifier for an alarm

\note this identifier is signed because -1 is used as an error condition when creating alarms

\note alarm ids may be reused, however for convenience the implementation makes an attempt to defer reusing as long as possible. You should certainly expect it to be hundreds of ids before one is reused, although in most cases it is more. Nonetheless care must still be taken when cancelling alarms or other functionality based on alarms when the alarm may have expired, as eventually the alarm id may be reused for another alarm.

\ingroup alarm