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_RnkInitialize</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13<a name="dwc__ranking_8h_173c248d299ce23217350b63d6512eb15"></a>
14<h1 align="left">DWC_RnkInitialize</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_RnkInitialize.html#dwc__ranking_8h_173c248d299ce23217350b63d6512eb15>DWC_RnkInitialize</a>(const char *initdata,
22                              const DWCUserData *userdata);</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>initdata</STRONG></EM></TD>
32<TD width="87%">Private key string for communications.</TD>
33    </TR>
34
35    <TR>
36<TD width="13%"><EM><STRONG>userdata</STRONG></EM></TD>
37<TD width="87%">User data.</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_ERROR_INIT_ALREADYINITIALIZED</STRONG></EM></TD>
55<TD width="87%">Initialized.</TD>
56    </TR>
57
58    <TR>
59<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE</STRONG></EM></TD>
60<TD width="87%">Invalid initial data size.</TD>
61    </TR>
62
63    <TR>
64<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_INIT_INVALID_INITDATA</STRONG></EM></TD>
65<TD width="87%">Invalid initial data.</TD>
66    </TR>
67
68    <TR>
69<TD width="13%"><EM><STRONG>DWC_RNK_ERROR_INIT_INVALID_USERDATA</STRONG></EM></TD>
70<TD width="87%">Invalid user data.</TD>
71    </TR>
72
73  </TBODY>
74</TABLE>
75
76<H2>Description</H2>
77<p>Initializes the Ranking library.</p><p>The Ranking Library uses the GHTTP Library internally to perform communication. Consequently, when initializing the library using this function, the GHTTP Library is also initialized internally. Therefore, Ranking Library communication and GHTTP Library communication cannot be performed at the same time.</p><p>To close the library, call the <A href="DWC_RnkShutdown.html"><CODE>DWC_RnkShutdown</CODE></a> function.</p><p>This function will fail if the library is already initialized or if the initial data is invalid.</p><p>User data must contain a valid GS profile ID. The error <a href=Macro.html#dwc__ranking_8h_11e26643f8161b162f689f7031ace5910fa8759f04ea1c401bad3c44cbcd691ca><CODE>DWC_RNK_ERROR_INIT_INVALID_USERDATA</CODE></a> will occur if the data includes a provisional login ID that has never been used to log in or if the data's dirty flag has been set.</p><p>If the process has been interrupted due to an error or a cancellation, you will need to call <A href="DWC_RnkShutdown.html"><CODE>DWC_RnkShutdown</CODE></a> to end the process, then call this function again.</p><p>A private key string used for communications is issued for each game title. The server identifies the game title based on this private key. The ranking library cannot be used until Nintendo issues a private key string for the game title and the server is set up for the game.</p><p>The general-purpose ranking feature uses the GameSpy server. There are two types of servers provided: one for development and one for products. Switching between these servers is carried out by switching authentication servers using the <A href="DWC_Init.html"><CODE>DWC_Init</CODE></a> function.</p><p>The databases for the development server and the production server are separate, so the composition of the rankings they provide will be different.</p><p><BR><B>Note:</B> In the current version, the application cannot use <CODE>DWC_GHTTP</CODE> directly.</p>
78
79<H2>Revision History</H2>
80<DL>
81
82<DT><para>1.4.10</DT>
83<DD>Added text about the user data's dirty flag.</DD>
84
85<DT><para>1.4.15</DT>
86<DD>To reflect privatization of <CODE>DWC_GHTTP</CODE>, deleted the description of <CODE>DWC_ShutdownGHTTP</CODE>.</DD>
87
88</DL>
89<hr><p>CONFIDENTIAL</p></body>
90</html>
91