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>KBDSetAccessSticky</title>
10</head>
11
12<body>
13
14<h1>KBDSetAccessSticky</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/kbd.h&gt;
19
20KBDEc KBDSetAccessSticky(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 set.</TD>
28  </tr>
29  <tr>
30<TH>enable</TH>
31<TD>A BOOL value for setting the keyboard sticky key 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. <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>
40    </TD>
41  </tr>
42</TABLE>
43
44<h2>Description</h2>
45<p>Set the &quot;sticky&quot; key state of the USB keyboard on channel <SPAN class="argument">ch</SPAN>. The state is set to <SPAN class="argument">enable</SPAN>.
46
47<p>The sticky bit state controls the behavior of modifier keys that normally are active only while the keys such as Shift and Control are pressed down. With the sticky mode enabled, pressing the modifier key toggles the modifier state on or off. With the sticky mode disabled, the modifier state is only on while an appropriate modifier key is pressed down.</p>
48<p>The default value for <SPAN class="argument">enable</SPAN> is <CODE>FALSE</CODE>.</p>
49
50<h2>See Also</h2>
51<P class="reference">
52<a href="list.html">Keyboard API Function List</a>
53</p>
54
55<h2>Revision History</h2>
56<P>
572007/03/27 Initial version. <br>
58</p>
59
60<hr><p>CONFIDENTIAL</p></body>
61</HTML>