DWC_LoginAsync

構文

#include <dwc.h>
BOOL DWC_LoginAsync(const u16 *ingamesn,
                    const char *reserved,
                    DWCLoginCallback callback,
                    void *param);

引数

ingamesn 認証サーバに送信するスクリーンネーム。
  • 文字コードはUnicode(ビックエンディアンUTF16)を使用してください。
    それ以外の文字コードを使用している場合は、Unicodeに変換してください。
  • スクリーンネームにUnicode及びIPLフォントにない独自の文字を使用している場合は、スペースに置き換えてください。
  • 終端はu16で0x0000である必要があります。
  • 終端を除いて26文字以上の文字列を指定した場合は、先頭から25文字のみが認証サーバに送信されます。
  • 友達とのコミュニケーションしかない場合や、別途不正文字列チェック(複数文字列を同時に検査するため)をする場合で、
    本関数で不正文字列チェックを行わない場合は空文字列を指定してください。
reserved 通常は、NULLを指定してください。過去との互換性のために残されています。
callback ログイン完了コールバック関数へのポインタ
param ログイン完了コールバック用パラメータ

返り値

TRUE ログイン処理開始。コールバック関数で結果が通知されます。
FALSE 本関数を呼んで良い状態ではないか、もしくは引数ingamesnにNULLが指定されました。コールバック関数は呼ばれません。

説明

アプリケーションがGameSpyサーバを利用可能であるか調べ、リモート認証を行い、Wi-Fiコネクションへ接続します。

本関数を呼び出すには、インターネット接続後、DWC_InitFriendsMatch関数によるFriendsMatchライブラリ初期化処理まで完了している必要があります。

本関数呼出し後、DWC_ProcessFriendsMatch関数を呼び続ければログイン処理が進行し、処理が完了すれば、ログイン完了コールバックが呼び出されます。

ネットワーク接続状況により、関数からしばらく処理が戻らずブロックすることがあります。

認証サーバは、ゲーム内スクリーンネーム(ゲーム中でプレイヤーが使用する名前)がWi-Fiコネクション上で不適切なものでないかチェックします。Wi-Fiコネクションへの接続に成功した後、DWC_GetIngamesnCheckResult関数でそのチェック結果を取得してください。不正文字列チェックの詳細については、DWC_CheckProfanityAsync関数を参照してください。

なお、ROM内登録データのメーカーコードが未指定の場合、認証サーバとの通信でエラー(エラーコード20109)が発生しますので、ご注意ください。

また、FriendsMatchライブラリを使用しない場合は、本関数の代わりにDWC_NasLoginAsync関数を呼び出してください。

本APIは、内部でNHTTPStartup()を呼び出します。本APIを呼び出してからログインが完了するまでの前後で、重複してNHTTPを使用しないようにしてください。

参照

DWC_NasLoginAsync DWC_CheckProfanityAsync

履歴

5.1
誤って記載されていた情報を削除(SOライブラリ、DNSキャッシュ)
5.1pr2
引数ingamesnの説明で空文字列を指定する場合について、説明を追記

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