DWC_RnkInitialize

構文

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

引数

initdata 初期化データ(文字列)
userdata ユーザーデータ

返り値

DWC_RNK_SUCCESS 成功
DWC_RNK_ERROR_INIT_ALREADYINITIALIZED 初期化済
DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE 不正な初期化データサイズ
DWC_RNK_ERROR_INIT_INVALID_INITDATA 不正な初期化データ
DWC_RNK_ERROR_INIT_INVALID_USERDATA 不正なユーザーデータ

説明

ランキングライブラリを初期化します。

終了するときにはDWC_RnkShutdown関数を呼び出してください。

既に初期化済みの場合や初期化データが不正な場合は失敗します。

ユーザーデータは有効なGSプロファイルIDを含む必要があります。一度もログインしていない仮ログインIDを含むデータや、Dirtyフラグがセットされているデータではエラー(DWC_RNK_ERROR_INIT_INVALID_USERDATA)が発生します。

エラーやキャンセルで中断したときは、一度DWC_RnkShutdown関数で終了処理をしてから再度呼び出す必要があります。

引数の初期化データ(文字列)によってサーバはタイトルを識別します。初期化データは弊社への汎用ランキング機能の利用申請後に発行されます。弊社が初期化データを発行し、サーバの設定を行うまでランキングライブラリを使用することは出来ません。

また、必要であれば、DWC_SetRwinSize関数で、受信ウィンドウサイズをアプリ毎に適切な値に設定しておいて下さい。

汎用ランキング機能はGameSpyサーバを使用しており、開発向けサーバと製品向けサーバの2種類が提供されますが、この切り替えはDWC_SetAuthServer関数による認証サーバの切り替えにあわせて行なわれます。

また、開発向けと製品向けのサーバはデータベースがお互いに独立しているため、双方のランキングは異なるものとして構成されます。

履歴

5.1pr2より前の変更履歴はこちら