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>KBDGetLockProcessing</title>
10</head>
11
12<body>
13
14<h1>KBDGetLockProcessing</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/kbd.h&gt;
19
20KBDEc KBDGetLockProcessing(KBDChannel ch, BOOL *enable);
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>enable</TH>
31<TD>Pointer to a BOOL value for storing the modifier processing state.</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> is out of range.<br><code>KBD_ERR_BAD_POINTER</code> if <SPAN class="argument">enable</SPAN> is not a valid pointer.</TD>
40  </tr>
41</TABLE>
42
43<h2>Description</h2>
44<p>Returns the current lock modifier processing state of the USB keyboard on channel <SPAN class="argument">ch</SPAN>. The returned state is written to the area pointed to by <SPAN class="argument">enable</SPAN>.</p>
45<p>If the lock modifier processing state is <CODE>TRUE</CODE>, the KBD library processes all modifier keys as usual and sets the <code>KBDModState</code> accordingly. A lock modifier processing state of <CODE>FALSE</CODE> means that the KBD library will not process the locking modifier key presses, and the following <code>KBDModState</code> will be left unchanged:</p>
46<ul>
47<li><code>KBD_MS_CAPS_LOCK</code></li>
48<li><code>KBD_MS_NUM_LOCK</code></li>
49<li><code>KBD_MS_SCROLL_LOCK</code></li>
50<li><code>KBD_MS_LANG1</code></li>
51<li><code>KBD_MS_LANG2</code></li>
52</ul>
53<p>Processing of other <code>KBDModState</code> is still handled routinely. That is, pressing the Shift key will still set the <code>KBD_MS_SHIFT</code> bit in <code>KBDModState</code> regardless of the lock modifier processing state. The <code>KBDModState</code> is used to convert HID code to Unicode.</p>
54
55<h2>See Also</h2>
56<P class="reference">
57<a href="list.html">Keyboard API Function List</a>
58</p>
59
60<h2>Revision History</h2>
61<P>
622007/03/27 Initial version.<br>
63</p>
64
65<hr><p>CONFIDENTIAL</p></body>
66</HTML>