OSCancelAlarms

C Specification

#include <revolution/os.h>
void OSCancelAlarms ( u32 tag );

Arguments

tag Tag value of the alarm group to cancel (must be nonzero).

Return Values

None.

Description

Cancels the alarm groups that have the same tag set by the OSSetAlarmTag function.

Note: Alarms with tag values that are zero are reserved for operating system use and must not be canceled by game programs.

See Also

Alarm Functions, OSCreateAlarmOSSetAlarmOSSetAlarmTag

Revision History

03/01/2006 Initial version.