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.0.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<TITLE>OS_CreateAlarm</TITLE>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">OS_CreateAlarm <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_CreateAlarm( OSAlarm*  alarm );
17  </CODE></PRE>
18</DL>
19<H2>Arguments</H2>
20<TABLE border="1" width="100%">
21  <TBODY>
22    <TR>
23      <TD width="13%"><EM><STRONG>alarm</STRONG></EM></TD>
24      <TD width="87%">Pointer to the alarm structure to initialize</TD>
25    </TR>
26  </TBODY>
27</TABLE>
28<H2>Return Values</H2>
29<P>None.</P>
30<H2>Description</H2>
31<P>Initializes the alarm structure.</P>
32<P>One alarm can be set per alarm structure. Initialize the alarm structure with this function before using it for the first time.</P>
33<BLOCKQUOTE>Example:<br /> <code>OSAlarm alarm; OS_CreateAlarm( &amp;alarm ); OS_SetAlarm( &amp;alarm, count, callback, arg );</code>
34</BLOCKQUOTE>
35<P>Before calling <code>OS_CreateAlarm()</code>, the alarm library must be initialized with <a href="OS_InitAlarm.html"><code>OS_InitAlarm()</code></a>.</P>
36<H2>See Also</H2>
37<P><CODE><A href="OS_InitAlarm.html">OS_InitAlarm</A>, <A href="OS_SetAlarm.html">OS_SetAlarm</A><BR></CODE></P>
38<H2>Revision History</H2>
39<P>2004/02/04 Initial version.</P>
40<hr><p>CONFIDENTIAL</p></body>
41</HTML>