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 http-equiv="Content-Style-Type" content="text/css">
6<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
7<title>KPADGetWPADCLRingBuffer</title>
8</head>
9
10<body>
11
12<h1>KPADGetWPADCLRingBuffer</h1>
13
14<h2>Syntax</h2>
15<dl><dd><pre class="construction">
16#include &lt;revolution/kpad.h&gt;
17
18WPADCLStatus *KPADGetWPADCLRingBuffer( s32 chan );
19</pre></dd></dl>
20
21<h2>Arguments</h2>
22<TABLE class="arguments" border="1" >
23  <TBODY>
24    <TR>
25<TH>chan</TH>
26<TD>One of the <code>WPAD_CHAN<i>n</i></code> values.</TD>
27    </TR>
28  </TBODY>
29</TABLE>
30
31<h2>Return Values</h2>
32<p>
33Returns the start address of the <a href="../wpad/WPADStatus.html"><code>WPADCLStatus</code></a> structure ring buffer.
34</p>
35
36<H2>Description</H2>
37<p>
38The KPAD library, unlike the KPADOld library, <font color="#ff0000">does not use</font> the WPAD library auto-sampling. This function is used for maintaining compatibility with the KPADOld library, but it does not necessarily operate the same way.
39</p>
40
41<p>
42In the KPADOld library, this function was used as follows:
43</p>
44<blockquote>
45<p>
46To reference values in a <a href="../wpad/WPADStatus.html"><CODE>WPADCLStatus</CODE></a> structure directly, use the <a href="../wpad/WPADGetLatestIndexInBuf.html"><CODE>WPADGetLatestIndexInBuf</CODE></a> function in parallel to reference the appropriate value.
47</p>
48</blockquote>
49<p>
50However, the controller must be in a stable state where data format does not change, not in a state that immediately follows its connection/disconnection or the insertion/removal of external extension controllers. Because such conditions cannot be guaranteed, the use of this function is <font color="#ff0000">not recommended</font>.
51</p>
52
53<p>
54In the KPAD library, <a href="./KPADGetUnifiedWpadStatus.html"><CODE>KPADGetUnifiedWpadStatus</CODE></a> should be used instead.
55</p>
56
57<h2>See Also</h2>
58<p class="reference">
59<a href="./KPADGetUnifiedWpadStatus.html">KPADGetUnifiedWpadStatus</a>
60</p>
61
62<H2>Revision History</H2>
63<P>
642006/10/25 Revised the description to match KPAD version 2.<br>2006/09/07 Initial version.<br>
65</P>
66
67<hr><p>CONFIDENTIAL</p></body>
68</html>