1<html>
2
3<head>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
7<title>HIDCloseAsync</title>
8</head>
9
10<body>
11
12<h1>HIDCloseAsync</h1>
13
14<h2>Syntax</h2>
15
16<dl>
17<dd>
18<pre><code>#include &lt;revolution/hid.h&gt;</code></pre>
19</dd>
20<dd>
21<pre><code>HIDError HIDCloseAsync (
22            HIDSetupHandler hsh,
23            u32             user
24            );</code></pre>
25</dd>
26</dl>
27
28<h2>Arguments</h2>
29
30<TABLE border="1" cellpadding="3" cellspacing="0.1">
31
32<tr>
33<TD bgcolor="#ffffe8" width="120"><SPAN class="argument">HIDSetupHandler hsh</SPAN></TD>
34<TD width="520">
35Pointer to the <code>HIDSetupHandler</code> user callback function. The <CODE>HIDCloseAsync</CODE> function calls this callback function to report the results of cleaning up and closing. During a debug build, <code>ASSERTMSG</code> is performed if <code>HIDSetupHandler</code> is invalid.
36
37</TD>
38</tr>
39
40<tr>
41<TD bgcolor="#ffffe8" width="120"><SPAN class="argument">u32 user</SPAN></TD>
42<TD width="520">
43User-defined parameter. This variable is passed to the <code>HIDSetupHandler</code> callback function defined by the user.
44
45</TD>
46</tr>
47
48</TABLE>
49
50<h2>Return Values</h2>
51
52
53<TABLE border="1" cellpadding="3" cellspacing="0.1">
54
55<tr>
56<TD width="120" bgcolor="#ffffe8"><code>HID_ERROR_OK</code></TD>
57<TD width="520">
58The function was successful. The result is reported asynchronously by the user-defined <code>HIDSetupHandler</code> callback function.
59</TD>
60</tr>
61
62<tr>
63<TD width="120" bgcolor="#ffffe8"><code>HID_ERROR_NOT_OPEN</code></TD>
64<TD width="520">
65The HID library is not open.
66</TD>
67</tr>
68
69<tr>
70<TD width="120" bgcolor="#ffffe8"><code>HID_ERROR_FIRMWARE_MALFUNCTION</code></TD>
71<TD width="520">
72The HID library has received an error from the firmware.
73</TD>
74</tr>
75
76<tr>
77<TD width="120" bgcolor="#ffffe8"><code>HID_ERROR_BUSY</code></TD>
78<TD width="520">
79The HID library is busy.
80</TD>
81</tr>
82
83</TABLE>
84
85<h2>Description</h2>
86
87<p>Cleans up and closes the HID library after it is no longer needed for run-time use. The user can use the HID API functions during the time between the call to <code>HIDOpenAsync</code> and the call to <code>HIDCloseAsync</code>.
88
89<h2>See Also</h2>
90<p><a href="HIDOpenAsync.html"><CODE>HIDOpenAsync</CODE></a><BR> <a href="HIDSetupHandler.html"><CODE>HIDSetupHandler</CODE></a><BR> <a href="HIDError.html"><CODE>HIDError</CODE></a>
91</p>
92
93<h2>Revision History</h2>
94
95<P>2008/09/24 Initial version.</p>
96
97<hr>
98
99<hr><p>CONFIDENTIAL</p></body>
100</HTML>
101