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>OSSetAlarmTag</title>
10</head>
11
12<body>
13
14<h1>OSSetAlarmTag</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/os.h&gt;
19
20void OSSetAlarmTag ( OSAlarm* alarm, u32 tag );
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26    <TH><STRONG><EM><CODE>alarm</CODE></EM></STRONG></TH>
27    <TD>Pointer to alarm to set tag.</TD>
28  </tr>
29  <tr>
30    <TH><STRONG><EM><CODE>tag</CODE></EM></STRONG></TH>
31    <TD>Tag value to set.</TD>
32  </tr>
33</TABLE>
34
35<h2>Return Values</h2>
36<P>None.</P>
37
38<h2>Description</h2>
39<P>Sets a tag to an alarm. The tag is used to cancel a group of alarms with the <A href="OSCancelAlarms.html"><code>OSCancelAlarms</code></A> function.</P>
40
41<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>
42
43<h2>See Also</h2>
44<P class="reference">
45<a target="contents" href="../toc.html#Alarm">Alarm Functions</a><BR><a href="OSCancelAlarm.html">OSCancelAlarm</a><BR><a href="OSCancelAlarms.html">OSCancelAlarms</a><BR><a href="OSCreateAlarm.html">OSCreateAlarm</a><BR><a href="OSSetPeriodicAlarm.html">OSSetPeriodicAlarm</a>
46</p>
47
48<H2>Revision History</H2>
49<P>
502008/09/01 Added -1 (<CODE>0xFFFFFFFF</CODE>) to the tag values that must not be used.<br>2006/03/01 Initial version.<br>
51</P>
52
53<hr><p>CONFIDENTIAL</p></body>
54</html>