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>KPRPutChar</title> 10</head> 11 12<body> 13 14<h1>KPRPutChar</h1> 15 16<h2>Syntax</h2> 17<dl><dd><pre class="construction"> 18#include <revolution/kpr.h> 19 20u8 KPRPutChar(KPRQueue *queue, wchar_t inChar); 21</pre></dd></dl> 22 23<h2>Arguments</h2> 24<TABLE class="arguments" border="1" > 25 <tr> 26<TH><STRONG><EM><CODE>queue</CODE></EM></STRONG></TH> 27<TD>Pointer to a queue to add character to.</TD> 28 </tr> 29 <tr> 30<TH>inChar</TH> 31<TD>UTF-16 Character to be added to queue</TD> 32 </tr> 33</TABLE> 34 35<h2>Return Values</h2> 36<p>Returns the number of processed characters available for output.</p> 37 38<h2>Description</h2> 39<p>This function inserts a character into the given processing queue. Characters are processed as they are inserted.</p> 40<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 try to remove characters in a loop, since one input may generate multiple outputs. An output of 0 indicates that the queue is empty.</p> 41<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> 42<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. In order to generate output when the Alt key is released, the value <code>KPR_FLUSH_AKP_CHAR</code> should be entered into the queue. This value itself is absorbed by the queue and does not become available for output.</p> 43<p>This function may also be used to flush all the unprocessed characters in the queue (and make them available for output). To do so, the value <code>KPR_FLUSH_ALL_CHAR</code> should be entered into the queue. This value itself is absorbed by the queue and does not become available for output.</p> 44 45<h2>See Also</h2> 46<P class="reference"> 47<a href="list.html">Key Processing Functions</a>, 48<a href="KPRGetChar.html">KPRGetChar</a> 49</p> 50 51<H2>Revision History</H2> 52<P> 532007/07/09 Initial version.<br> 54</P> 55 56<hr><p>CONFIDENTIAL</p></body> 57</HTML>