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_SetOneTimeVAlarm</TITLE>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">OS_SetOneTimeVAlarm <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_SetOneTimeVAlarm(
17             OSVAlarm*           alarm ,
18             s16                 count ,
19             OSVAlarmHandler     handler ,
20             void*           arg );
21  </CODE></PRE>
22</DL>
23<H2>Arguments</H2>
24<TABLE border="1" width="100%">
25  <TBODY>
26    <TR>
27      <TD width="13%"><EM><STRONG>alarm</STRONG></EM></TD>
28      <TD width="87%">Pointer to the V-Count alarm structure for setting V-Count alarm</TD>
29    </TR>
30    <TR>
31      <TD width="13%"><EM><STRONG>count</STRONG></EM></TD>
32      <TD width="87%">The V-Count value at which the V-Count alarm is actuated (the handler is called)</TD>
33    </TR>
34    <TR>
35      <TD><EM><STRONG>handler</STRONG></EM></TD>
36      <TD>The V-Count alarm handler</TD>
37    </TR>
38    <TR>
39      <TD><EM><STRONG>arg</STRONG></EM></TD>
40      <TD>The argument when calling the V-Count alarm handler</TD>
41    </TR>
42  </TBODY>
43</TABLE>
44<H2>Return Values</H2>
45<P>None.</P>
46<H2>Description</H2>
47<P>This function configures a one-shot V-Count alarm. It is meant to give compatibility with <a href="OS_SetVAlarm.html"><code>OS_SetVAlarm()</code></a> prior to NITRO-SDK 2.0 RC1.</P>
48<P>In the old format of <a href="OS_SetVAlarm.html"><code>OS_SetVAlarm()</code></a>, the function took four arguments (the pointer to the alarm structure, the V-Count, the handler, and the handler's argument). Now that the <em><strong><code>delay</code></strong></em> value can be specified, the function has five arguments. For this reason, the <code>OS_SetOneTimeVAlarm()</code> function has been prepared for times when you want to configure the V alarm with the old-format arguments. Although this function does not have the <em><strong><code>delay</code></strong></em> argument, it operates internally as if <code><em><strong>delay</strong></em>&nbsp;=&nbsp;10</code>.</P>
49<BLOCKQUOTE><CODE>OS_SetOneTimeVAlarm( alarm, count, handler, arg );</CODE></BLOCKQUOTE>
50<P>is the inline version of</P>
51<BLOCKQUOTE><CODE>OS_SetVAlarm( alarm, count, 10, handler, arg );</CODE></BLOCKQUOTE>
52<P>&nbsp;</P>
53<P>For more details, see <a href="OS_SetVAlarm.html"><code>OS_SetVAlarm()</code></a> or <a href="OS_InitVAlarm.html"><code>OS_InitVAlarm()</code></a>.</P>
54<H2>See Also</H2>
55<P><CODE><A href="OS_InitVAlarm.html">OS_InitVAlarm</A>, <A href="OS_SetVAlarm.html">OS_SetVAlarm</A></CODE></P>
56<H2>Revision History</H2>
57<P>2004/10/22 Initial version.</P>
58<hr><p>CONFIDENTIAL</p></body>
59</HTML>