1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" /> 5<meta name="GENERATOR" content="Microsoft FrontPage 5.0" /> 6<meta http-equiv="Content-Style-Type" content="text/css" /> 7<link rel="stylesheet" type="text/css" href="../CSS/revolution.css" /> 8<base target="main" /> 9<title>Keyboard (KBD) API Function List</title> 10</head> 11<body> 12<h1><a name="USB Keyboard API Function List">Keyboard (KBD) API Function List</a></h1> 13 14<h2><A name="Init_Exit">Initialization and Termination</A></h2> 15<TABLE class="api_list" border="1"> 16 <tr> 17<th nowrap><a href="KBDInitRegionUS.html">KBDInitRegionUS</a></th> 18<td>Initializes keyboard maps for the US region.</td> 19 </tr> 20 <tr> 21<th nowrap><a href="KBDInitRegionJP.html">KBDInitRegionJP</a></th> 22<td>Initializes keyboard maps for the JP region.</td> 23 </tr> 24 <tr> 25<th nowrap><a href="KBDInitRegionEU.html">KBDInitRegionEU</a></th> 26<td>Initializes keyboard maps for the EU region.</td> 27 </tr> 28 <tr> 29<th nowrap><a href="KBDInit.html">KBDInit</a></th> 30<td>Initializes the USB keyboard library.</td> 31 </tr> 32 <tr> 33<th nowrap><a href="KBDExit.html">KBDExit</a></th> 34<td>Terminates the USB keyboard library.</td> 35 </tr> 36</table> 37 38<h2><A name="Sync">Synchronous Input</A></h2> 39<TABLE class="api_list" border="1"> 40 <tr> 41<th nowrap><a href="KBDGetKey.html">KBDGetKey</a></th> 42<td>Returns the key press (or release) stored at the head of the KBD library's internal, low-level key queue. </td> 43 </tr> 44</table> 45 46<h2><A name="Async">Asynchronous Input</A></h2> 47<TABLE class="api_list" border="1"> 48 <tr> 49<th nowrap><a href="KBDSetKeyCallback.html">KBDSetKeyCallback</a></th> 50<td>Registers a function to call when each physical key is pressed or released. </td> 51 </tr> 52</table> 53 54<h2><A name="Translate">Conversions</A></h2> 55<TABLE class="api_list" border="1"> 56 <tr> 57<th nowrap><a href="KBDTranslateHidCode.html">KBDTranslateHidCode</a></th> 58<td>Given an HID code, modifier state, and country code, returns the <CODE>KBDUnicode</CODE> value from the appropriate key map. </td> 59 </tr> 60</table> 61 62<h2><A name="Country">Country Setting</A></h2> 63<TABLE class="api_list" border="1"> 64 <tr> 65<th nowrap><a href="KBDGetCountry.html">KBDGetCountry</a></th> 66<td>Returns the country code for a keyboard channel.</td> 67 </tr> 68 <tr> 69<th nowrap><a href="KBDSetCountry.html">KBDSetCountry</a></th> 70<td>Sets the country map to use for a keyboard channel.</td> 71 </tr> 72</table> 73 74<h2><A name="Keyboard_State">Keyboard Status</A></h2> 75<TABLE class="api_list" border="1"> 76 <tbody> 77 <tr> 78<th nowrap><a href="KBDGetAccessSticky.html">KBDGetAccessSticky</a></th> 79<td>Gets the sticky state of the keyboard (whether modifier keys toggle state or are transient). </td> 80 </tr> 81 <tr> 82<th nowrap><a href="KBDSetAccessSticky.html">KBDSetAccessSticky</a></th> 83<td>Sets the sticky state of the keyboard.</td> 84 </tr> 85 <tr> 86<th nowrap><a href="KBDGetChannelStatus.html">KBDGetChannelStatus</a></th> 87<td>Gets the status of a keyboard channel as being connected or disconnected . </td> 88 </tr> 89 <tr> 90<th nowrap><a href="KBDResetChannel.html">KBDResetChannel</a></th> 91<td>Resets a keyboard to the initial state. Clears all keys.</td> 92 </tr> 93 <tr> 94<th nowrap><a href="KBDGetLockProcessing.html">KBDGetLockProcessing</a></th> 95<td>Gets the status of the lock modifier processing as being enabled or disabled. </td> 96 </tr> 97 <tr> 98<th nowrap><a href="KBDSetLockProcessing.html">KBDSetLockProcessing</a></th> 99<td>Sets the lock modifier processing to enabled or disabled.</td> 100 </tr> 101 <tr> 102<th nowrap><a href="KBDGetModState.html">KBDGetModState</a></th> 103<td>Gets the current modifier state.</td> 104 </tr> 105 <tr> 106<th nowrap><a href="KBDSetModState.html">KBDSetModState</a></th> 107<td>Sets the current modifier state.</td> 108 </tr> 109 <tr> 110<th nowrap><a href="KBDGetRepeat.html">KBDGetRepeat</a></th> 111<td>Gets the current key repeat parameters. </td> 112 </tr> 113 <tr> 114<th nowrap><a href="KBDSetRepeat.html">KBDSetRepeat</a></th> 115<td>Sets the current key repeat parameters. </td> 116 </tr> 117 <tr> 118<th nowrap><a href="KBDSetAttachCallback.html">KBDSetAttachCallback</a></th> 119<td>Registers a function to call when a USB keyboard is attached.</td> 120 </tr> 121 <tr> 122<th nowrap><a href="KBDSetDetachCallback.html">KBDSetDetachCallback</a></th> 123<td>Registers a function to call when a USB keyboard is detached.</td> 124 </tr> 125 <tr> 126<th nowrap><a href="KBDSetLeds.html">KBDSetLeds</a></th> 127<td>Sends a LED command to a keyboard (blocking call).</td> 128 </tr> 129 <tr> 130<th nowrap><a href="KBDSetLedsAsync.html">KBDSetLedsAsync</a></th> 131<td>Sends a LED command to a keyboard (non-blocking call).</td> 132 </tr> 133 <tr> 134<th nowrap><a href="KBDSetLedsRetry.html">KBDSetLedsRetry</a></th> 135<td>Sends a LED command to a keyboard (non-blocking, retrying call).</td> 136 </tr> 137 </tbody> 138</table> 139 140<h2><A name="Structure">Structures</A></h2> 141<TABLE class="api_list" border="1"> 142 <tbody> 143 <tr> 144<th nowrap><a href="KBDDevEvent.html">KBDDevEvent</a></th> 145<td>A structure used by the callback that notifies of a USB keyboard device being physically connected or disconnected.</td> 146 </tr> 147 <tr> 148<th nowrap><a href="KBDKeyEvent.html">KBDKeyEvent</a></th> 149<td>Structure that stores USB keyboard input and other information.</td> 150 </tr> 151 <tr> 152<th nowrap><a href="KBDLedEvent.html">KBDLedEvent</a></th> 153<td>A structure used by the callback of the LED command that is sent to the USB keyboard.</td> 154 </tr> 155 <tr> 156<th nowrap><a href="types.html">Constants, Enumerators, and Types</a></th> 157<td>Other constants, enumerators, and types.</td> 158 </tr> 159 </tbody> 160</table> 161 162<BR> 163 164<hr><p>CONFIDENTIAL</p></body> 165</HTML>