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>C Specification</h2>
17
18<dl>
19<dd><pre><code>#include &lt;revolution/os.h&gt;</code></pre>
20  </dd>
21<dd><pre><CODE>void OSCancelAlarms ( u32 tag );</CODE></pre>
22  </dd>
23</dl>
24<h2>Arguments</h2>
25<TABLE border="1" cellpadding="3" cellspacing="0.1">
26
27    <tr>
28<TD width="120" bgcolor="#ffffe8"><code><b><i><STRONG><EM><CODE>tag</CODE></EM></STRONG></i></b></code></TD>
29<TD width="520">Tag value of the alarm group  to cancel (must be nonzero).</TD>
30    </tr>
31
32</TABLE>
33<h2>Return Values</h2>
34<P>None.</P>
35<h2>Description</h2>
36<P>Cancels the alarm groups that have the same tag set by the <code>OSSetAlarmTag</code> function. </P>
37<P><strong>Note:</strong> Alarms with tag values that are zero are reserved for operating system use and must not be canceled by game programs.</P>
38
39<h2>See Also</h2>
40
41<p><a target="contents" href="../toc.html#Alarm">Alarm Functions</a>, <code><a href="OSCreateAlarm.html">OSCreateAlarm</a></code>,&nbsp; <a href="OSSetAlarm.html"><code>OSSetAlarm</code></a>,&nbsp; <code><a href="OSSetAlarmTag.html">OSSetAlarmTag</a></code></p>
42<H2>Revision History</H2>
43<P>2006/03/01 Initial version.</P>
44<hr>
45<P>CONFIDENTIAL</p>
46</BODY>
47</HTML>