1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.1.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<TITLE>OS_SetAlarmTag</TITLE>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">OS_SetAlarmTag <IMG src="../../image/NTR.gif" align="middle"><IMG src="../../image/TWL.gif" align="middle"></H1>
12<H2>Syntax</H2>
13<DL>
14  <DD>
15  <PRE><CODE>#include &lt;nitro/os.h&gt;</CODE></PRE>
16  <PRE><CODE>void OS_SetAlarmTag( OSAlarm* alarm, u32 tag );  </CODE></PRE>
17</DL>
18<H2>Arguments</H2>
19<TABLE border="1" width="100%">
20  <TBODY>
21    <TR>
22      <TD width="13%"><EM><STRONG>alarm</STRONG></EM></TD>
23      <TD width="87%">Pointer to the alarm structure that sets the tag</TD>
24    </TR>
25    <TR>
26      <TD width="13%"><EM><STRONG>tag</STRONG></EM></TD>
27      <TD width="87%">The tag that is set.</TD>
28    </TR>
29  </TBODY>
30</TABLE>
31<H2>Return Values</H2>
32<P>None.</P>
33<H2>Description</H2>
34<P>Sets a tag to an alarm.</P>
35<P>These alarm tags are used by <a href="OS_CancelAlarms.html"><code>OS_CancelAlarms()</code></a> to cancel all of the alarms belonging to a specified tag group. Values from 1 to 255 can be set for <SPAN class="argument">tag</SPAN>. A value of 0 is reserved by the system and cannot be used by applications.</P>
36<H2>See Also</H2>
37<P><CODE><A href="OS_InitAlarm.html">OS_InitAlarm</A>, <A href="OS_CancelAlarms.html">OS_CancelAlarms</A></CODE></P>
38<H2>Revision History</H2>
39<P>2004/02/04 Initial version.</P>
40<hr><p>CONFIDENTIAL</p></body>
41</HTML>