DWC_RnkInitialize

Syntax

#include <dwc.h>
DWCRnkError DWC_RnkInitialize(const char *initdata,
                              const DWCUserData *userdata);

Arguments

initdata Initialization data (string).
userdata User data.

Return Values

DWC_RNK_SUCCESS Succeeded
DWC_RNK_ERROR_INIT_ALREADYINITIALIZED Initialized
DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE Invalid initialization data size
DWC_RNK_ERROR_INIT_INVALID_INITDATA Invalid initialization data
DWC_RNK_ERROR_INIT_INVALID_USERDATA Invalid user ID

Description

Initializes the Ranking library.

To shut down the library, call the DWC_RnkShutdown function.

This function fails if the library is already initialized or if the initialization data is invalid.

User data must contain a valid GS profile ID. The error DWC_RNK_ERROR_INIT_INVALID_USERDATA occurs 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 need to call DWC_RnkShutdown to perform close processing, and then call this function again.

The server differentiates titles based on the initialization data (string) of the argument. The initialization data is issued after you have applied to Nintendo to use the general-purpose ranking server. You cannot use the Ranking library until after Nintendo has issued the initialization data and the server has been configured.

In addition, the DWC_SetRwinSize function can set the appropriate value for a receiving window for each application if necessary.

The general-purpose ranking feature uses the GameSpy server. There are two server types available, one for development and one for the final production version. Switching between them is performed in conjunction with authentication server switching using the DWC_InitForDevelopment and DWC_InitForProduction functions.

The databases for the development server and the production server are separate, so both of their rankings are configured differently.

Note: Use DWC_RnkInitializeDebug instead of this function if debugging requires you to generate many sets of user data and upload large amounts of ranking data to the server.

Revision History

5.4
Noted that to debug significant uploading, you need to use the DWC_RnkInitializeDebug function.
5.3
Revised Description because the specification was changed to switch the authentication server using either the DWC_InitForDevelopment or the DWC_InitForProduction functions, and not with the DWC_SetAuthServer function.

For the change log prior to 5.1 PR2, click here.   


CONFIDENTIAL