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 http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8<title>OSGetAlarmUserData</title>
9</head>
10
11<body>
12
13<h1>OSGetAlarmUserData</h1>
14
15<h2>Syntax</h2>
16<dl><dd><pre class="construction">
17#include &lt;revolution/os.h&gt;
18
19void* OSGetAlarmUserData( const OSAlarm* alarm );
20</pre></dd></dl>
21
22<h2>Arguments</h2>
23<TABLE class="arguments" border="1" >
24  <tr>
25    <TH>alarm</TH>
26    <TD>Pointer to the alarm for getting user data.</TD>
27  </tr>
28</TABLE>
29
30<h2>Return Values</h2>
31<p>
32The user data set in the <code>OSAlarm</code> structure.
33</p>
34
35<H2>Description</H2>
36<P>
37Gets the user data stored in the <code>OSAlarm</code> structure. To configure user data in the <code>OSAlarm</code> structure, use the <a href="OSSetAlarmUserData.html"><code>OSSetAlarmUserData</code></a> function.
38</P>
39
40<h2>See Also</h2>
41<P class="reference">
42<a target="contents" href="../toc.html#Alarm">Alarm Functions</a><BR><a href="OSSetAlarmUserData.html">OSSetAlarmUserData</a>
43</p>
44
45<H2>Revision History</H2>
46<P>
472006/07/xx Initial version.<br>
48</P>
49
50<hr><p>CONFIDENTIAL</p></body>
51</html>
52