1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>OSCancelAlarms</title>
10</head>
11
12<body>
13
14<h1>OSCancelAlarms</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/os.h&gt;
19
20void OSCancelAlarms ( u32 tag );
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26    <TH>tag</TH>
27    <TD>Tag value of the alarm group  to cancel (must be nonzero).</TD>
28  </tr>
29</TABLE>
30
31<h2>Return Values</h2>
32<P>None.</P>
33
34<h2>Description</h2>
35<P>Cancels the group of alarms having the same tag set using the <code>OSSetAlarmTag</code> function.</P>
36<P><B>Note: </B>Alarms with tag values of 0 or -1 (<CODE>0xFFFFFFFF</CODE>) are reserved for operating system use and must not be used by game programs.</P>
37
38<h2>See Also</h2>
39<P class="reference">
40<a target="contents" href="../toc.html#Alarm">Alarm Functions</a>,
41<a href="OSCreateAlarm.html">OSCreateAlarm</a>,
42<a href="OSSetAlarm.html">OSSetAlarm</a>,
43<a href="OSSetAlarmTag.html">OSSetAlarmTag</a>
44</p>
45
46<H2>Revision History</H2>
47<P>
482008/09/01 Added -1 (<CODE>0xFFFFFFFF</CODE>) to the tag values that must not be used.<br>2006/03/01 Initial version.
49</P>
50
51<hr><p>CONFIDENTIAL</p></body>
52</html>