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>KPADGetWPADFSRingBuffer</title>
8</head>
9
10<body>
11
12
13
14<h1>KPADGetWPADFSRingBuffer</h1>
15
16<h2>C Specification</h2>
17<dl>
18<dd><pre><code>#include &lt;revolution/kpad.h&gt;</code></pre>
19  </dd>
20<dd><pre><code>WPADFSStatus *KPADGetWPADFSRingBuffer( s32 chan ) ;</code></pre>
21  </dd>
22</dl>
23
24<h2>Arguments</h2>
25<p>
26<TABLE border="1">
27  <TBODY>
28    <TR>
29<TD><code><b><i>chan</i></b></code></TD>
30<TD>One of <code>WPAD_CHAN<i>n</i></code> values.</TD>
31    </TR>
32  </TBODY>
33</TABLE>
34</p>
35
36<h2>Return Values</h2>
37<p>
38Returns the starting address of the <a href="../wpad/WPADStatus.html"><code>WPADFSStatus</code></a> structure ring buffer.
39</p>
40
41<H2>Description</H2>
42<p>
43The KPAD library, unlike the KPADOld library, <font color="ff0000">does not use</font> the WPAD library auto-sampling. This function is provided to maintain compatibility with KPADOld library, but does not necessarily operate in an identical manner.
44</p>
45
46<p>
47In the KPADOld library, this function was used as follows:
48</p>
49<blockquote>
50<p>
51When you wish to directly access values in the <a href="../wpad/WPADFSStatus.html"><code>WPADFSStatus</code></a> structure, appropriate values can be accessed through the joint use of the <a href="../wpad/WPADGetLatestIndexInBuf.html"><code>WPADGetLatestIndexInBuf</code></a> function.
52</p>
53</blockquote>
54<p>
55However, the controller must be in a stable state with no data format change, and not at controller connection/disconnection or swapping of external extension controllers. Because such condition cannot be guaranteed, the use of this function is <font color="ff0000">not recommended</font>.
56</p>
57
58<p>
59In the KPAD library, the use of <a href="./KPADGetUnifiedWpadStatus.html">KPADGetUnifiedWpadStatus</a> function is recommended in its place.
60</p>
61
62<h2>See Also</h2>
63<p>
64<a href="./KPADGetUnifiedWpadStatus.html">KPADGetUnifiedWpadStatus</a><br>
65</p>
66
67<H2>Revision History</H2>
68<P>
692006/10/25 Revised description to match KPAD version 2.<br>2006/03/01 Initial version.<br>
70</P>
71
72</body>
73</html>