#include <cafe/os.h> BOOL OSCancelAlarm(OSAlarm* alarm);
|alarm||Pointer to the alarm to cancel.|
BOOL indicating whether the alarm was previously created and initialized.
Cancels the specified alarm. Failure to cancel alarms results in continued consumption of system timing resources.
OSCancelAlarm stops a running timer from executing. Calling
OSCancelAlarm on a non-initialized
OSAlarm is a programming error.
2013-05-08 Automated cleanup pass.
BOOL result to the API.
2010-08-30 Initial version.