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<title>General-Purpose Ranking - Constants</title> 8<LINK rel="stylesheet" href="../css/nitro.css" type="text/css"> 9</head> 10 11<body> 12 13<h1 align="left">General-Purpose Ranking - Constants</h1> 14<H2>Definition</H2> 15<DL> 16 <DD> 17 <PRE><CODE> 18#include <dwc.h> 19 20#define DWC_RNK_DATA_MAX 764 21#define DWC_RNK_CATEGORY_MAX 1000 22#define DWC_RNK_GET_MAX 30 23#define DWC_RNK_FRIENDS_MAX 64 24 25enum { 26 DWC_RNK_ORDER_ASC 0 27 DWC_RNK_ORDER_DES 1 28}; 29 30enum DWCRnkError { 31 DWC_RNK_SUCCESS 0 32 DWC_RNK_IN_ERROR 33 DWC_RNK_ERROR_INVALID_PARAMETER 34 DWC_RNK_ERROR_INIT_ALREADYINITIALIZED 35 DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE 36 DWC_RNK_ERROR_INIT_INVALID_INITDATA 37 DWC_RNK_ERROR_INIT_INVALID_USERDATA 38 DWC_RNK_ERROR_PUT_NOTREADY 39 DWC_RNK_ERROR_PUT_INVALID_KEY 40 DWC_RNK_ERROR_PUT_NOMEMORY 41 DWC_RNK_ERROR_GET_NOTREADY 42 DWC_RNK_ERROR_GET_INVALID_KEY 43 DWC_RNK_ERROR_GET_NOMEMORY 44 DWC_RNK_ERROR_CANCEL_NOTASK 45 DWC_RNK_PROCESS_NOTASK 46 DWC_RNK_PROCESS_TIMEOUT 47 DWC_RNK_ERROR_INVALID_MODE 48 DWC_RNK_ERROR_NOTCOMPLETED 49 DWC_RNK_ERROR_EMPTY_RESPONSE 50}; 51 52enum DWCRnkState { 53 DWC_RNK_STATE_NOTREADY 0 54 DWC_RNK_STATE_INITIALIZED 55 DWC_RNK_STATE_PUT_ASYNC 56 DWC_RNK_STATE_GET_ASYNC 57 DWC_RNK_STATE_COMPLETED 58 DWC_RNK_STATE_TIMEOUT 59 DWC_RNK_STATE_ERROR 60}; 61 62enum DWCRnkRegion { 63 DWC_RNK_REGION_JP 0x01 64 DWC_RNK_REGION_US 0x02 65 DWC_RNK_REGION_EU 0x04 66 DWC_RNK_REGION_KR 0x08 67 DWC_RNK_REGION_CH 0x10 68 DWC_RNK_REGION_ALL 0xff 69}; 70 71enum DWCRnkGetMode { 72 DWC_RNK_GET_MODE_ORDER 73 DWC_RNK_GET_MODE_TOPLIST 74 DWC_RNK_GET_MODE_NEAR 75 DWC_RNK_GET_MODE_FRIENDS 76 DWC_RNK_GET_MODE_NEAR_HI 77 DWC_RNK_GET_MODE_NEAR_LOW 78}; 79 80 </CODE></PRE> 81 </DD> 82</DL> 83 84<H2><A>Constants</A></H2> 85 86<TABLE border="1"> 87 <TBODY> 88 89 <a name="dwc__ranking_8h_13066f77a00f280132a1d64d306975777"></a> 90 <TR> 91 <TH width="25%"><A>DWC_RNK_DATA_MAX</A></TH> 92 <TD>Maximum size to be used for user-defined data.</TD> 93 </TR> 94 95 <a name="dwc__ranking_8h_192c348bb621e1f4486daf931679df6d1"></a> 96 <TR> 97 <TH width="25%"><A>DWC_RNK_CATEGORY_MAX</A></TH> 98 <TD>Maximum value that can be specified for a category.</TD> 99 </TR> 100 101 <a name="dwc__ranking_8h_1358c47d628992447812312fe4648a89a"></a> 102 <TR> 103 <TH width="25%"><A>DWC_RNK_GET_MAX</A></TH> 104 <TD>Upper limit on the number of rankings that can be retrieved.</TD> 105 </TR> 106 107 <a name="dwc__ranking_8h_1913f4aa84f44c33e7a5dfbf0b48cd92d"></a> 108 <TR> 109 <TH width="25%"><A>DWC_RNK_FRIENDS_MAX</A></TH> 110 <TD>Maximum number of friends.</TD> 111 </TR> 112 113 </TBODY> 114</TABLE> 115 116<a name="dwc__ranking_8h_161dadd085c1777f559549e05962b2c9e"></a> 117<H2><A name="TAG_ENUM_1">Constants Indicating Ascending and Descending Order of the Ranking List to be Retrieved</A></H2> 118<TABLE border="1"> 119 <TBODY> 120 121 <TR> 122 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ORDER_ASC</CODE></STRONG></EM></TD> 123 <TD>Ascending order.</TD> 124 </TR> 125 126 <TR> 127 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ORDER_DES</CODE></STRONG></EM></TD> 128 <TD>Descending order.</TD> 129 </TR> 130 131 </TBODY> 132</TABLE> 133 134<a name="dwc__ranking_8h_11e26643f8161b162f689f7031ace5910"></a> 135<H2><A name="TAG_ENUM_2">Error Codes</A></H2> 136<TABLE border="1"> 137 <TBODY> 138 139 <TR> 140 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_SUCCESS</CODE></STRONG></EM></TD> 141 <TD>Succeeded.</TD> 142 </TR> 143 144 <TR> 145 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_IN_ERROR</CODE></STRONG></EM></TD> 146 <TD>An error is occurring.</TD> 147 </TR> 148 149 <TR> 150 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_INVALID_PARAMETER</CODE></STRONG></EM></TD> 151 <TD>Invalid parameter.</TD> 152 </TR> 153 154 <TR> 155 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_INIT_ALREADYINITIALIZED</CODE></STRONG></EM></TD> 156 <TD>Initialized.</TD> 157 </TR> 158 159 <TR> 160 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE</CODE></STRONG></EM></TD> 161 <TD>Invalid initial data size.</TD> 162 </TR> 163 164 <TR> 165 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_INIT_INVALID_INITDATA</CODE></STRONG></EM></TD> 166 <TD>Invalid initial data.</TD> 167 </TR> 168 169 <TR> 170 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_INIT_INVALID_USERDATA</CODE></STRONG></EM></TD> 171 <TD>Invalid user information.</TD> 172 </TR> 173 174 <TR> 175 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_PUT_NOTREADY</CODE></STRONG></EM></TD> 176 <TD>Not initialized.</TD> 177 </TR> 178 179 <TR> 180 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_PUT_INVALID_KEY</CODE></STRONG></EM></TD> 181 <TD>Invalid encryption key.</TD> 182 </TR> 183 184 <TR> 185 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_PUT_NOMEMORY</CODE></STRONG></EM></TD> 186 <TD>Insufficient memory.</TD> 187 </TR> 188 189 <TR> 190 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_GET_NOTREADY</CODE></STRONG></EM></TD> 191 <TD>Not initialized.</TD> 192 </TR> 193 194 <TR> 195 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_GET_INVALID_KEY</CODE></STRONG></EM></TD> 196 <TD>Invalid encryption key.</TD> 197 </TR> 198 199 <TR> 200 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_GET_NOMEMORY</CODE></STRONG></EM></TD> 201 <TD>Insufficient memory.</TD> 202 </TR> 203 204 <TR> 205 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_CANCEL_NOTASK</CODE></STRONG></EM></TD> 206 <TD>No processing during asynchronous processing.</TD> 207 </TR> 208 209 <TR> 210 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_PROCESS_NOTASK</CODE></STRONG></EM></TD> 211 <TD>No processing during asynchronous processing.</TD> 212 </TR> 213 214 <TR> 215 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_PROCESS_TIMEOUT</CODE></STRONG></EM></TD> 216 <TD>Timeout.</TD> 217 </TR> 218 219 <TR> 220 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_INVALID_MODE</CODE></STRONG></EM></TD> 221 <TD>Invalid mode.</TD> 222 </TR> 223 224 <TR> 225 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_NOTCOMPLETED</CODE></STRONG></EM></TD> 226 <TD>Communications not completed.</TD> 227 </TR> 228 229 <TR> 230 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_ERROR_EMPTY_RESPONSE</CODE></STRONG></EM></TD> 231 <TD>Empty response.</TD> 232 </TR> 233 234 </TBODY> 235</TABLE> 236 237<a name="dwc__ranking_8h_11103f24ff80fe1419472d4765ab4895f"></a> 238<H2><A name="TAG_ENUM_3">Module Status</A></H2> 239<TABLE border="1"> 240 <TBODY> 241 242 <TR> 243 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_STATE_NOTREADY</CODE></STRONG></EM></TD> 244 <TD>Uninitialized.</TD> 245 </TR> 246 247 <TR> 248 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_STATE_INITIALIZED</CODE></STRONG></EM></TD> 249 <TD>Initialized.</TD> 250 </TR> 251 252 <TR> 253 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_STATE_PUT_ASYNC</CODE></STRONG></EM></TD> 254 <TD>Currently executing asynchronous PUT process.</TD> 255 </TR> 256 257 <TR> 258 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_STATE_GET_ASYNC</CODE></STRONG></EM></TD> 259 <TD>Currently executing asynchronous GET process.</TD> 260 </TR> 261 262 <TR> 263 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_STATE_COMPLETED</CODE></STRONG></EM></TD> 264 <TD>Done.</TD> 265 </TR> 266 267 <TR> 268 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_STATE_TIMEOUT</CODE></STRONG></EM></TD> 269 <TD>Timeout.</TD> 270 </TR> 271 272 <TR> 273 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_STATE_ERROR</CODE></STRONG></EM></TD> 274 <TD>Error occurred.</TD> 275 </TR> 276 277 </TBODY> 278</TABLE> 279 280<a name="dwc__ranking_8h_1bc0db3fbc51ac91811958f9c51e87899"></a> 281<H2><A name="TAG_ENUM_4">Region Codes</A></H2> 282<TABLE border="1"> 283 <TBODY> 284 285 <TR> 286 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_REGION_JP</CODE></STRONG></EM></TD> 287 <TD>Japan</TD> 288 </TR> 289 290 <TR> 291 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_REGION_US</CODE></STRONG></EM></TD> 292 <TD>North America</TD> 293 </TR> 294 295 <TR> 296 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_REGION_EU</CODE></STRONG></EM></TD> 297 <TD>Europe</TD> 298 </TR> 299 300 <TR> 301 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_REGION_KR</CODE></STRONG></EM></TD> 302 <TD>Korea</TD> 303 </TR> 304 305 <TR> 306 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_REGION_CH</CODE></STRONG></EM></TD> 307 <TD>China</TD> 308 </TR> 309 310 <TR> 311 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_REGION_ALL</CODE></STRONG></EM></TD> 312 <TD>World</TD> 313 </TR> 314 315 </TBODY> 316</TABLE> 317 318<a name="dwc__ranking_8h_1b024592ea57f7ecd5b76caee1edc5b19"></a> 319<H2><A name="TAG_ENUM_5">Modes for Getting DWC_RnkGetScoreAsync</A></H2> 320<TABLE border="1"> 321 <TBODY> 322 323 <TR> 324 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_GET_MODE_ORDER</CODE></STRONG></EM></TD> 325 <TD>Order.</TD> 326 </TR> 327 328 <TR> 329 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_GET_MODE_TOPLIST</CODE></STRONG></EM></TD> 330 <TD>High score.</TD> 331 </TR> 332 333 <TR> 334 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_GET_MODE_NEAR</CODE></STRONG></EM></TD> 335 <TD>Nearby scores.</TD> 336 </TR> 337 338 <TR> 339 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_GET_MODE_FRIENDS</CODE></STRONG></EM></TD> 340 <TD>Ranking with friends specified.</TD> 341 </TR> 342 343 <TR> 344 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_GET_MODE_NEAR_HI</CODE></STRONG></EM></TD> 345 <TD>Nearby scores (higher than one's own ranking).</TD> 346 </TR> 347 348 <TR> 349 <TD width="25%"><EM><STRONG><CODE>DWC_RNK_GET_MODE_NEAR_LOW</CODE></STRONG></EM></TD> 350 <TD>Nearby scores (lower than one's own ranking).</TD> 351 </TR> 352 353 </TBODY> 354</TABLE> 355 356<hr><p>CONFIDENTIAL</p></body> 357</html> 358