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>KPRLookAhead</title>
10</head>
11
12<body>
13
14<h1>KPRLookAhead</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/kpr.h&gt;
19
20u8 KPRLookAhead(KPRQueue *queue, wchar_t *string, u32 maxSize);
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 retrieve characters from.</TD>
28  </tr>
29  <tr>
30<TH>string</TH>
31<TD>Pointer to a <code>wchar_t</code> value to receive characters from queue</TD>
32  </tr>
33  <tr>
34<TH>maxSize</TH>
35<TD>Indicates the maximum number of <code>wchar_t</code> values that <SPAN class="argument">string</SPAN> can hold.</TD>
36  </tr>
37</TABLE>
38
39<h2>Return Values</h2>
40<p>Returns the number of characters in a queue.</p>
41
42<h2>Description</h2>
43<p>This function may be used to retrieve a copy of all the characters in a processing queue, including characters that have been entered but not yet processed.</p>
44<p>The area pointed to by <SPAN class="argument">string</SPAN> should be big enough to hold a <code>KPR_MAX_QUEUE_LEN</code> number of <code>wchar_t</code> values.</p>
45<p>If <SPAN class="argument">string</SPAN> == <code>NULL</code> or if <SPAN class="argument">maxSize</SPAN> == <code>0</code>, then the function only returns the number of characters that are available to be copied.</p>
46<p>With only dead-key processing enabled, there can be a maximum of one unprocessed character in the queue (a dead key or combining accent character). Alt+keypad keystrokes are not stored in the queue as characters, so they are retrieved as individual characters. With Romaji conversion, there may be up to 4 unprocessed characters in the queue.</p>
47<p>This function does not dequeue the characters that are retrieved; it just gets a copy.</p>
48
49<h2>See Also</h2>
50<P class="reference">
51<a href="list.html">Key Processing Functions</a>,
52<a href="KPRGetChar.html">KPRGetChar</a>
53</p>
54
55<H2>Revision History</H2>
56<P>
572007/07/09 Initial version.<br>
58</P>
59
60<hr><p>CONFIDENTIAL</p></body>
61</HTML>