OSCancelAlarm

Syntax

#include <cafe/os.h>

BOOL OSCancelAlarm(OSAlarm* alarm);

Parameters

alarm Pointer to the alarm to cancel.

Return Values

BOOL indicating whether the alarm was previously created and initialized.

Description

Cancels the specified alarm. Failure to cancel alarms results in continued consumption of system timing resources.

Calling OSCancelAlarm stops a running timer from executing. Calling OSCancelAlarm on a non-initialized OSAlarm is a programming error.

Do Not Call From

None.

See Also

OSCancelAlarms
OSSetAlarm
OSSetPeriodicAlarm
OSWaitAlarm

Revision History

2013-05-08 Automated cleanup pass.
2011-03-17 Added BOOL result to the API.
2010-08-30 Initial version.


CONFIDENTIAL