DWC_RnkInitialize

Syntax

#include <dwc.h>

DWCRnkError DWC_RnkInitialize(const char *initdata,
                              const DWCUserData *userdata);

Arguments

initdata Private key string for communications.
userdata User data.

Return Values

DWC_RNK_SUCCESS Succeeded.
DWC_RNK_ERROR_INIT_ALREADYINITIALIZED Initialized.
DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE Invalid initial data size.
DWC_RNK_ERROR_INIT_INVALID_INITDATA Invalid initial data.
DWC_RNK_ERROR_INIT_INVALID_USERDATA Invalid user data.

Description

Initializes the Ranking library.

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.

To close the library, call the DWC_RnkShutdown function.

This function will fail if the library is already initialized or if the initial data is invalid.

User data must contain a valid GS profile ID. The error DWC_RNK_ERROR_INIT_INVALID_USERDATA 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.

If the process has been interrupted due to an error or a cancellation, you will need to call DWC_RnkShutdown to end the process, then call this function again.

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.

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 DWC_Init function.

The databases for the development server and the production server are separate, so the composition of the rankings they provide will be different.


Note: In the current version, the application cannot use DWC_GHTTP directly.

Revision History

1.4.10
Added text about the user data's dirty flag.
1.4.15
To reflect privatization of DWC_GHTTP, deleted the description of DWC_ShutdownGHTTP.

CONFIDENTIAL