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>KPRGetChar</title>
10</head>
11
12<body>
13
14<h1>KPRGetChar</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/kpr.h&gt;
19
20wchar_t KPRGetChar(KPRQueue *queue);
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<TH>queue</TH>
27<TD>Pointer to the queue from which to retrieve a processed character.</TD>
28  </tr>
29</TABLE>
30
31<h2>Return Values</h2>
32<p>Returns the character gotten from the head of the queue.</p>
33
34<h2>Description</h2>
35<p>This function retrieves a processed character from the head of a keyboard processing queue.</p>
36<p>Characters should be entered into the appropriate queue as they are generated by the keyboard. Immediately after entering the character in the queue, the application should try to get the processed characters from the queue. The application should remove characters using loop processing, because in some cases a single input may generate multiple outputs. An output of 0 indicates that the queue is empty.</p>
37<p>It is an application error to add characters to a queue and not try to remove them immediately afterwards. The queue is not designed to hold more characters than can be processed at once. Overflowing the queue will result in a fatal error.</p>
38<p>In order to support Alt+keypad keys, dedicated Unicode values <code>KBK_Keypad_0</code> through <code>KBK_Keypad_9</code> are placed in the queue whenever the Alt key is pressed while Num Lock is active and one of the keys 0-9 on the keypad is being pressed. The number 0 is placed on the queue when the Alt key is released, in order to generate output.</p>
39
40<h2>See Also</h2>
41<P class="reference">
42<a href="list.html">Key Processing Functions</a>, <a href="KPRPutChar.html">KPRPutChar</a>
43</p>
44
45<H2>Revision History</H2>
46<P>
472007/07/09 Initial version.<br>
48</P>
49
50<hr><p>CONFIDENTIAL</p></body>
51</HTML>