DWC_StartUtility

構文

#include <dwc.h>
int DWC_StartUtility(void *work,
                     int language,
                     int param);

引数

work 32バイトアライメントされたDWC_UTILITY_WORK_SIZEバイトのバッファへのポインタ。関数終了後は破棄してかまいません。
language Wi-Fiコネクション設定内の言語を指定します。
基本的にはアプリケーションで使用している言語を指定してください。ただし、paramで指定する仕向地によっては選択できない言語があります。本関数で*対応していない言語をアプリケーションで使用している場合は、本関数が対応している言語の中から適切なものを選択してください。
  • DWC_LANGUAGE_JAPANESE  //日本語
  • DWC_LANGUAGE_ENGLISH  //英語
  • DWC_LANGUAGE_FRENCH   //フランス語
  • DWC_LANGUAGE_GERMAN   //ドイツ語
  • DWC_LANGUAGE_ITALIAN  //イタリア語
  • DWC_LANGUAGE_SPANISH  //スペイン語
  • DWC_LANGUAGE_HANGUL   //韓国語*
param 仕向地、Wi-Fiコネクション設定の開始位置を指定します。仕向地によりらくらく無線スタートの有無が変わります。
  • トップメニューから開始。実装が必須です。
    • DWC_UTILITY_TOP_MENU_FOR_USA  //仕向地北米
    • DWC_UTILITY_TOP_MENU_FOR_EUR  //仕向地欧州
    • DWC_UTILITY_TOP_MENU_FOR_JPN  //仕向地日本
    • DWC_UTILITY_TOP_MENU_COMMON  //上記以外の仕向地共通

  • 「接続先の選択」から開始。実装は必須でありません。
    • DWC_UTILITY_SETTING_FOR_USA  //仕向地北米
    • DWC_UTILITY_SETTING_FOR_EUR  //仕向地欧州
    • DWC_UTILITY_SETTING_FOR_JPN  //仕向地日本
    • DWC_UTILITY_SETTING_COMMON   //上記以外の仕向地共通

返り値

DWC_UTIL_RESULT_SUCCESS 正常終了
DWC_UTIL_RESULT_FAILED 引数エラー
DWC_UTIL_RESULT_ERROR_TWL Twlで起動したときのエラー

説明

Wi-Fiコネクション設定を開始します。

必要なバッファを外部から与えるDWC_StartUtility関数とstaticに確保されたものを使用するDWC_StartUtilityEx関数があります。

Wi-Fiコネクション設定は、TWL_ARCHGENをLIMITEDに指定したビルドの場合(TWL専用モード)は、実装する必要はありません。TWLでは、本体設定からWi-Fiコネクションの設定ができるので、ユーザーにはそちらを利用してもらいます。

TWL_ARCHGENをHYBRIDに指定したビルドの場合(NITRO/TWL両対応モード)、DS,DSLite上で動作させた場合本関数は正常に動作しますが、TWL上で動作させた場合、本関数は必ず、DWC_UTIL_RESULT_ERROR_TWLのエラーを返します。このDWC_UTIL_RESULT_ERROR_TWLエラーが返ったとき、必ずガイドラインに規定されているメッセージを表示するようにしてください。

Wi-Fiコネクション設定は、次の機能をプレイヤーに提供するための共通のインターフェイスです

呼び出し時には次の点に留意してください。

引数paramでWi-Fiコネクション設定の開始位置を指定できますが、アプリケーション内には必ず「トップメニュー」から開始できるシーンが必要です。
これは、「接続先の選択」から開始するとWi-Fiコネクション設定の全ての機能が使用できないためです。
「接続先の選択」から開始するオプションは、インターネットへの接続エラーが発生した際に、プレイヤーを直接、接続先の設定へ導くような実装を行なうことを想定したもので、必須の実装ではありません。

すべての処理を終了させてから呼び出してください。
具体的な注意点は、以下のとおりです。

内部でTWL-DWC以外のTWL-SDK、TWL-System、TWL-WiFiの各ライブラリを呼び出しています。
これらに関連するライブラリは「Wi-Fiコネクション設定」の実行時に予めメモリにロードされている必要がありますので、下記リストのライブラリをオーバレイモジュールとして使用する場合はご注意ください。また、これらのライブラリをカスタマイズした場合は正常に動作しない可能性がありますのでご注意ください。

FINALROM版の場合、DWC_InitForDevelopment/DWC_InitForProduction関数の設定に関わらず製品向け認証サーバを使用します。

Wi-Fiコネクション設定は、白単色の画面から始まるように作成されています。そのため、アプリケーションを白単色の画面にしてから呼び出すと、自然に繋がります。

また、関数が正常終了した後は次の点に留意してください。(引数エラーで終了した場合は何も処理されません)

Wi-Fiコネクション設定は、TWL-SDKのファイルシステムによりDSカード上のファイルを参照します。$(TWLDWC_ROOT)/file/dwc/utility.binをルートディレクトリにディレクトリ名dwc/で配置してください。アプリケーションで、ファイルシステムを使用しない場合は、ROMスペックファイルのRomSpecセッションに下記の記述を付け加え、アプリケーション側でFS_Init()を呼び出してファイルシステムを使用できるようにしてください。

RomSpec
{
  ...
  #ここから
  HostRoot  ./file/dwc   #PC側ファイルディレクトリ名
  Root  /dwc
  File  utility.bin
  #ここまで
}


参考:言語と仕向地の組み合わせとらくらく無線スタートの有無

言語仕向地らくらく無線スタート備考
日本語日本有り---
日本語日本以外---エラー
日本語以外北米・欧州・共通無し---
日本語以外日本---エラー

履歴

5.3
認証サーバの切り替えを、DWC_SetAuthServer関数ではなくDWC_InitForDevelopment/DWC_InitForProduction関数で行うよう仕様変更したため、関連する記述を修正

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