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 http-equiv="Content-Style-Type" content="text/css">
7<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
8<title>DWC_RnkResGetRow</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__ranking_8h_17f7e3dca113ad8708c5ec4dffe869c1b"></a>
14<h1 align="left">DWC_RnkResGetRow</h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;dwc.h&gt;</CODE><BR>
20  <BR>
21  <PRE><CODE><a href=Macro.html#dwc__ranking_8h_11e26643f8161b162f689f7031ace5910>DWCRnkError</a> <a href=DWC_RnkResGetRow.html#dwc__ranking_8h_17f7e3dca113ad8708c5ec4dffe869c1b>DWC_RnkResGetRow</a>(<a href=DWCRnkData.html#>DWCRnkData</a> *out,
22                             u32 index);</CODE></PRE></dd>
23</dl>
24
25<h2>Arguments</h2>
26
27<TABLE border="1" width="100%">
28  <TBODY>
29
30    <TR>
31<TD width="13%"><EM><STRONG>out</STRONG></EM></TD>
32<TD width="87%">Pointer to the <A href="DWCRnkData.html"><CODE>DWCRnkData</CODE></a> structure to retrieve data from.</TD>
33    </TR>
34
35    <TR>
36<TD width="13%"><EM><STRONG>index</STRONG></EM></TD>
37<TD width="87%">The index being obtained.</TD>
38    </TR>
39
40  </TBODY>
41</TABLE>
42
43<h2>Return Values</h2>
44
45<TABLE border="1" width="100%">
46  <TBODY>
47
48    <TR>
49<TD width="13%"><EM><STRONG>DWC_RNK_SUCCESS</STRONG></EM></TD>
50<TD width="87%">Succeeded.</TD>
51    </TR>
52
53    <TR>
54<TD width="13%"><EM><STRONG>DWC_RNK_IN_ERROR</STRONG></EM></TD>
55<TD width="87%">An error is occurring.</TD>
56    </TR>
57
58    <TR>
59<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_INVALID_MODE</STRONG></EM></TD>
60<TD width="87%">Invalid mode.</TD>
61    </TR>
62
63    <TR>
64<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_INVALID_PARAMETER</STRONG></EM></TD>
65<TD width="87%">Invalid parameter.</TD>
66    </TR>
67
68    <TR>
69<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_NOTCOMPLETED</STRONG></EM></TD>
70<TD width="87%">Communications not completed.</TD>
71    </TR>
72
73    <TR>
74<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_EMPTY_RESPONSE</STRONG></EM></TD>
75<TD width="87%">Empty response.</TD>
76    </TR>
77
78  </TBODY>
79</TABLE>
80
81<H2>Description</H2>
82<p>Extracts and gets an arbitrary row from the ranking list obtained via communications.</p><p>The buffer for the obtained data is released either when the <A href="DWC_RnkShutdown.html"><CODE>DWC_RnkShutdown</CODE></a> function is called or when the next asynchronous process starts. Save a backup as necessary.</p><p>A ranking will be stored in the <CODE>order</CODE> field of the row which holds the local player's own score. However, an exception to this occurs in top ranking list retrieval mode: in this mode 0 is stored in the local player's own score row, as well as in the other rows.</p>
83
84<H2>Revision History</H2>
85<DL>
86
87<DT><para>1.1.2</DT>
88<DD>Added an explanation of the conditions in which ranking is stored to the <CODE>order</CODE> field.</DD>
89
90</DL>
91<hr><p>CONFIDENTIAL</p></body>
92</html>
93