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 name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
9<title>KBDGetChannelStatus</title>
10</head>
11
12<body>
13
14<h1>KBDGetChannelStatus</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/kbd.h&gt;
19
20KBDEc KBDGetChannelStatus(KBDChannel ch, KBDChanStatus *status);
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<TH>ch</TH>
27<TD>Keyboard channel to query.</TD>
28  </tr>
29  <tr>
30<TH>status</TH>
31<TD>Pointer to a <CODE>KBDChanStatus</CODE> value to store the channel status.</TD>
32  </tr>
33</TABLE>
34
35<h2>Return Values</h2>
36<TABLE class="arguments" border="1" >
37  <tr>
38<TH>KBDEc</TH>
39<TD>Keyboard error code.<br><code>KBD_SUCCESS</code> if the call was successful.<br><code>KBD_ERR_NOT_INITIALIZED</code> if the library was not initialized.<br><code>KBD_ERR_BAD_VALUE</code> if <SPAN class="argument">ch</SPAN> was out of range.<br><code>KBD_ERR_BAD_POINTER</code> if <SPAN class="argument">status</SPAN> was not a valid pointer.</TD>
40  </tr>
41</TABLE>
42
43<h2>Description</h2>
44<p>Returns the current status of the USB keyboard on channel <SPAN class="argument">ch</SPAN>. The returned status is written to the area pointed to by <SPAN class="argument">status</SPAN>. The channel status is a bit vector with the following possible values:</p>
45<ul>
46<li><code>KBD_CS_OK</code>: the keyboard is connected and working normally.</li>
47<li><code>KBD_CS_DISCONNECTED</code>: the keyboard is not connected.</li>
48<li><code>KBD_CS_ROLL_OVER</code>: too many keys are currently pressed down.</li>
49<li><code>KBD_CS_ERROR</code>: either a keyboard POST (power-on self-test) failure or other undefined error has occurred.</li>
50</ul>
51
52<h2>See Also</h2>
53<P class="reference">
54<a href="list.html">Keyboard API Function List</a>
55</p>
56
57<h2>Revision History</h2>
58<P>
592007/03/27 Initial version.<br>
60</p>
61
62<hr><p>CONFIDENTIAL</p></body>
63</HTML>