OSCancelAlarms

Syntax

#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 group of alarms having the same tag set using the OSSetAlarmTag function.

Note: Alarms with tag values of 0 or -1 (0xFFFFFFFF) are reserved for operating system use and must not be used by game programs.

See Also

Alarm Functions
OSCreateAlarm
OSSetAlarm
OSSetAlarmTag

Revision History

2008/09/01 Added -1 (0xFFFFFFFF) to the tag values that must not be used.
2006/03/01 Initial version.


CONFIDENTIAL