TWLDWCライブラリ(DWC) API 機能一覧

共通・ユーティリティ

初期化

DWC_Init DWCライブラリを初期化します。
DWC_Debug_DWCInitError DWC_Init関数のエラーチェックのための関数です。(デバッグ用)

エラー関係

DWC_GetLastError 最後の通信エラー種別を取得します。
DWC_GetLastErrorEx 最後の通信エラー種別を取得します。ライブラリの復帰種別を取得できる拡張版です。
DWC_ClearError 通信エラーの記録をクリアします。

メモリ割り当て

DWCAllocEx DWCライブラリ全体で使用するメモリ確保関数
DWCFreeEx DWCライブラリ全体で使用するメモリ開放関数
DWC_SetMemFunc 通信用のメモリ確保/解放関数を設定します。
DWC_Alloc アプリケーションがセットした関数でメモリを確保します。
DWC_AllocEx アプリケーションがセットした関数でメモリを確保します。
DWC_Free アプリケーションがセットした関数でメモリを解放します。
DWC_Realloc アプリケーションがセットした関数でメモリを拡張します。
DWC_ReallocEx アプリケーションがセットした関数でメモリを拡張します。

Base64変換

DWC_Base64Encode 指定されたデータをBase64でエンコードします。
DWC_Base64Decode 指定されたBase64文字列をデコードします。

文字列操作

DWC_SetCommonKeyValueString key/value文字列を作成します。
DWC_AddCommonKeyValueString key/value文字列を追加します。
DWC_GetCommonValueString key/value文字列からkey文字列に対応するvalue文字列を取得します。

デバッグ出力

DWC_SetReportLevel デバッグ表示レベルを指定します。

定数、マクロ、列挙型

こちらを参照してください。

アカウント

ユーザーデータ

DWC_CreateUserData ユーザデータを作成します。
DWC_CheckUserData ユーザデータの正当性を確認します。
DWC_CheckValidConsole ユーザデータとセットのDS本体かどうかを確認します。
DWC_CheckHasProfile ユーザデータが既に有効なプロファイル(ログインID)を取得しているかどうかを確認します。
DWC_CheckDirtyFlag ユーザデータが更新されているかどうかを示すDirtyフラグをチェックします。
DWC_ClearDirtyFlag ユーザデータが更新されているかどうかを示すDirtyフラグをクリアします。
DWC_CreateFriendKey ユーザデータから、相手に渡す友達登録鍵を生成します。
DWC_CreateFriendKeyLegacy ユーザデータから、相手に渡す友達登録鍵を生成します。(旧仕様)
DWC_CreateExchangeToken DSワイヤレス通信で交換するための友達情報をユーザデータから作成します。
DWC_CreateFriendKeyToken 友達リストに格納するための友達情報を友達登録鍵から作成します。
DWC_GetFriendKey 友達情報から友達登録鍵を取得します。
DWC_CheckFriendKey 友達登録鍵の正当性を確認します。
DWC_CheckFriendKeyLegacy 友達登録鍵の正当性を確認します。(旧仕様)
DWC_FriendKeyToString 友達登録鍵を10進12桁の文字列に変換します。
DWC_StringToFriendKey 10進12桁の文字列を友達登録鍵に変換します。
DWC_IsEqualFriendData 友達情報が同じかどうかを確認します。
DWC_IsValidFriendData 友達情報に有効なデータがセットされているかどうかを調べます。
DWC_IsBuddyFriendData 友達情報が既にGameSpyサーバ上で友達関係になっているかどうかを調べます。
DWC_WasBuddyFriendData 引数に指定した友達が、自分との友達関係を破棄したかどうかを調べます。
DWC_ClearBuddyFlagFriendData 友達情報の友達成立フラグをクリアします。
DWC_GetFriendDataType 友達情報の保存されているデータタイプを取得します。
DWC_GetGsProfileId 友達情報からGSプロファイルIDを取得します。
DWC_ReportFriendData 友達情報を表示します。(デバッグ用)
DWC_ReportUserData ユーザデータを表示します。(デバッグ用)
DWC_SetGsProfileId 友達情報にGSプロファイルIDをセットします。(デバッグ用)

本体情報

DWC_GetAuthenticatedUserId DS本体に保存されている認証済みのユーザIDを取得します。

インターネット接続

インターネット接続

DWC_InitInet 自動接続制御オブジェクトを初期化する関数です。
DWC_InitInetEx 自動接続制御オブジェクトを初期化する関数です。(詳細指定版)
DWC_SetAuthServer どの認証サーバで認証を行うかを指定する関数です。
DWC_SetRwinSize TCPで使うrwinサイズを設定します。
DWC_SetConnectApType 自動接続処理で接続するAPの種別を明示的に指定する関数です。(デバッグ用)
DWC_ConnectInetAsync 自動接続処理を開始する関数です。
DWC_DebugConnectInetAsync 自動接続処理を開始する関数です。
DS本体の設定を使わず特定のAPを指定します。(デバッグ用)
DWC_CheckInet 自動接続処理の進行状態を確認する関数です。
DWC_ProcessInet 自動接続処理を実行する関数です。
DWC_GetInetStatus インターネット接続状態を取得する関数です。
DWC_UpdateConnection アクセスポイントとの接続を確認する関数です。
DWC_GetApInfo 接続中のアクセスポイントに関する情報を取得する関数です。
DWC_GetProxySetting 接続中のアクセスポイントに関するproxy設定情報を取得する関数です。
DWC_GetLinkLevel アクセスポイントとの間の無線電波強度を取得する関数です。
DWC_CleanupInet 自動接続制御を終了する関数です(同期版)
DWC_CleanupInetAsync 自動接続制御を終了する関数です(非同期版)
DWC_TestInetAsync インターネットとの接続テストを開始する関数です。
DWC_TestInetProcess インターネットとの接続テストの通信処理を実行する関数です。

Wi-Fiコネクション設定

DWC_StartUtility Wi-Fiコネクション設定を開始する関数です。
DWC_StartUtilityEx Wi-Fiコネクション設定を開始する関数です。(ワークメモリ無指定版)

構造体

DWCApInfo 接続中のアクセスポイントに関する情報を格納するための構造体です。
DWCProxySetting 接続中のアクセスポイントに関するproxy設定情報を取得する関数です。

定数、マクロ、列挙型

こちらを参照してください。

認証サーバー

ログイン

DWC_NASLoginAsync 任天堂認証サーバで認証を行いWi-Fiコネクションへの接続を行います。
DWC_NASLoginProcess 認証処理を進行させ、その状態を取得します。
DWC_NASLoginAbort 認証処理を中断します。

サーバー時間

DWC_GetDateTime 現在の日付と時刻をGMTで取得します。

サービスロケータ

DWC_SVLGetTokenAsync サービスロケータ情報を取得する処理を開始します。
DWC_SVLProcess サービスロケータ情報を取得する処理を進行させます。
DWC_SVLAbort サービスロケータ情報を取得する処理を中断します。

構造体

DWCSvlResult サービスロケータ情報取得結果を格納する構造体

定数、マクロ、列挙型

こちらを参照してください。

友達管理・マッチメイク

全般

DWCLoginCallback ログイン完了コールバック型
DWCConnectionClosedCallback コネクションクローズコールバック型
DWC_InitFriendsMatch DWCFriendsMatchライブラリを初期化します。
DWC_ShutdownFriendsMatch DWCFriendsMatchライブラリを終了し、ライブラリ内部で確保しているヒープ領域を解放します。
DWC_ProcessFriendsMatch 通信処理を更新します。
DWC_LoginAsync Wi-Fiコネクションへの接続を行います。
DWC_UpdateServersAsync ローカルの友達リストとGameSpyサーバ上の友達リストとの同期をとります。
DWC_ConnectToAnybodyAsync 友達無指定ピアマッチメイク開始関数です。
DWC_ConnectToFriendsAsync 友達指定ピアマッチメイク開始関数です。
DWC_SetupGameServer サーバクライアントマッチメイクのサーバホスト起動関数です。
DWC_ConnectToGameServerAsync サーバクライアントマッチメイクのクライアントホスト接続開始関数です。
DWC_ConnectToGameServerByGroupID グループIDを指定してグループに再接続を試みます。
DWC_SetConnectionClosedCallback 接続が切断されたときに呼び出されるコールバック関数を設定します。
DWC_CloseConnectionHardFromServer 指定AIDのホストとの接続を切断する関数です。
DWC_CloseConnectionHardBitmapFromServer 指定AIDビットマップのホストとの接続を切断する関数です。
DWC_CloseAllConnectionsHard 接続を切断、または進行中の接続処理をキャンセルする関数です。
DWC_GetNumConnectionHost 接続ホスト数を取得する関数です。
DWC_GetMyAID 自分のAIDを取得する関数です。
DWC_GetAIDList 接続中ホストのAIDリストを取得する関数です。
DWC_GetAIDBitmap 接続中ホストのAIDビットマップを取得する関数です。
DWC_IsValidAID 指定のAIDと接続中であるかを調べる関数です。
DWC_GetState DWCFriendsMatchライブラリの内部状態を取得します。(デバッグ用)
DWC_GetServerAID グループへの受付を管理するサーバホストのAIDを取得する関数です。
DWC_IsServerMyself 新規参加の受付を行っているサーバホストが自分かどうかを取得します。
DWC_GetDirectConnectedAIDBitmap 自分と直接接続のある相手ホストのAIDビットマップを取得します。
DWC_GetIngamesnCheckResult ゲーム内スクリーンネームの認証サーバでのチェック結果を取得します。

友達リスト関係

DWCUpdateServersCallback 友達リスト同期処理コールバック型
DWCFriendStatusCallback 友達状態変化通知コールバック型
DWCDeleteFriendListCallback 友達リスト削除コールバック型
DWCBuddyFriendCallback バディ成立コールバック型
DWC_GetFriendStatus 友達の状態を取得します。(文字列版)
DWC_GetFriendStatusSC 友達の状態を取得します。(文字列・サーバクライアントマッチメイク時の接続数取得版)
DWC_GetFriendStatusData 友達の状態を取得します。(バイナリ版)
DWC_GetFriendStatusDataSC 友達の状態を取得します。(バイナリ・サーバクライアントマッチメイク時の接続数取得版)
DWC_GetNumFriend 友達リストに登録されている友達の数を取得します。
DWC_SetOwnStatusString 自分の状態をGameSpyサーバに登録します。(文字列版)
DWC_GetOwnStatusString 自分の状態を取得します。(文字列版)
DWC_SetOwnStatusData 自分の状態をGameSpyサーバに登録します。(バイナリ版)
DWC_GetOwnStatusData 自分の状態を取得します。(バイナリ版)
DWC_CanChangeFriendList 友達リストを変更してよいかどうかを確認します。
DWC_DeleteBuddyFriendData 友達リストから友達を削除し、GameSpyサーバ上の友達関係も削除します。
DWC_SetBuddyFriendCallback 友達関係が成立したときに呼び出されるコールバックを設定します。
DWC_SetFriendStatusCallback 友達の通信状態が変化したときに呼び出されるコールバックを設定します。

データストレージ関係

DWCStorageLoginCallback データストレージサーバ・ログインコールバック型
DWCSaveToServerCallback データストレージサーバ・セーブ完了コールバック型
DWCLoadFromServerCallback データストレージサーバ・ロード完了コールバック型
DWC_LoginToStorageServerAsync データストレージサーバにログインする関数です。
DWC_LogoutFromStorageServer データストレージサーバからログアウトする関数です。
DWC_SetStorageServerCallback データストレージサーバデータセーブ・ロード完了通知コールバック登録関数です。
DWC_SavePublicDataAsync データストレージサーバPublicデータセーブ関数です。
DWC_SavePrivateDataAsync データストレージサーバPrivateデータセーブ関数です。
DWC_LoadOwnPublicDataAsync データストレージサーバ 自分のPublicデータロード関数です。
DWC_LoadOwnPrivateDataAsync データストレージサーバ 自分のPrivateデータロード関数です。
DWC_LoadOthersDataAsync データストレージサーバ他人のデータロード関数です。

マッチメイク関係

DWCMatchedSCCallback マッチメイク完了コールバック型
DWCNewClientCallback 新規接続クライアント接続開始通知コールバック型
DWCEvalPlayerCallback プレイヤー評価コールバック型
DWCConnectAttemptCallback マッチメイク条件判定コールバック型
DWCSuspendCallback 締め切り完了コールバック型
DWC_RegisterMatchStatus マッチメイク用の自ホスト情報を先行して登録する関数です。
DWC_CancelMatch マッチメイク処理をキャンセルする関数です。(非推奨)
DWC_IsValidCancelMatch マッチメイク処理をキャンセルできるかどうか調べる関数です。(非推奨)
DWC_AddMatchKeyInt マッチメイク指標キー追加関数int版
DWC_AddMatchKeyString マッチメイク指標キー追加関数string版
DWC_GetMatchIntValue マッチメイク指標キー取得関数int版
DWC_GetMatchStringValue マッチメイク指標キー取得関数string版
DWC_GetLastMatchType 最後に行ったマッチメイクの種別を取得する関数です。
DWC_GetMatchState マッチメイク中の内部状態を取得する関数です。(デバッグ用)
DWC_GetGroupID 現在自分が参加しているグループのIDを取得する関数です。
DWC_RequestSuspendMatchAsync マッチメイクにおける新規参加の受付状態を変更する処理を開始します。
DWC_GetSuspendMatch 現在、新規ホストの参加受付を行っているかどうかを取得します。
DWC_GetConnectionUserData 指定AIDのホストに対応するconnectionUserDataを取得します。
DWC_SetDebugMeshNNRetryMax メッシュ構築時のNAT超えに失敗した際、リトライする最大回数を設定する関数です。(デバッグ用)
DWC_GetDebugMeshNNRetryMax メッシュ構築時のNAT超えに失敗した際、リトライする最大回数を取得する関数です。(デバッグ用)

送受信

DWC_GetUdpPacketDropNum 受信バッファ溢れのためにUDPパケットを受信できなかった回数を取得する関数です。
DWCUserSendCallback データの送信が完了したときに呼び出されるコールバック関数です。
DWCUserRecvCallback データの受信があったときに呼び出されるコールバック関数です。
DWCUserRecvTimeoutCallback 一定期間データの受信がないときに呼び出されるコールバック関数です。
DWCUserPingCallback DWC_Ping関数での測定結果を通知するコールバック関数です。
DWC_SendReliable Connection確立後、指定のAIDへUDPによるReliable送信を行う関数です。
DWC_SendReliableBitmap Connection確立後、指定のbitmapへUDPによるReliable送信を行う関数です。
DWC_SendUnreliable Connection確立後、指定のAIDへUDPによるUnreliable送信を行う関数です。
DWC_SendUnreliableBitmap Connection確立後、指定のbitmapへUDPによるUnreliable送信を行う関数です。
DWC_Ping 接続中の指定AIDの通信遅延を測定する関数です。
DWC_SetRecvBuffer 受信バッファを設定します。
DWC_SetUserSendCallback 送信コールバックの設定をする関数です。
DWC_SetUserRecvCallback 受信コールバックの設定をする関数です。
DWC_SetUserRecvTimeoutCallback 一定時間データを受信しなかったときの受信タイムアウトを通知するコールバック関数を設定する関数です。
DWC_SetRecvTimeoutTime 受信タイムアウトのタイムアウト時間を設定する関数です。
DWC_SetUserPingCallback 通信遅延の測定結果を受け取るコールバック関数を設定する関数です。
DWC_SetSendSplitMax Reliable送信の分割送信サイズを設定する関数です。
DWC_IsSendableReliable 指定AIDへのReliable送信可能かどうかをチェックする関数です。
DWC_SetConnectionKeepAliveTime 一定時間reliable/unreliable通信の無い接続相手を切断するための判断基準となる、タイムアウト時間を設定します。
DWC_GetConnectionKeepAliveTime 一定時間reliable/unreliable通信の無い接続相手を切断するための判断基準となる、タイムアウト時間を取得します。
DWC_SetSendDelay 送信時に遅延させる時間(単位:ms)を設定する関数です。(デバッグ用)
DWC_SetRecvDelay 受信時に遅延させる時間(単位:ms)を設定する関数です。(デバッグ用)
DWC_SetSendDrop 送信時のパケットロス率を設定する関数です。(デバッグ用)
DWC_SetRecvDrop 受信時のパケットロス率を設定する関数です。(デバッグ用)

定数、マクロ、列挙型

こちらを参照してください。

汎用ランキング

全般

DWC_RnkInitialize ランキングライブラリを初期化します。
DWC_RnkShutdown ランキングライブラリの終了処理を行います。
DWC_RnkPutScoreAsync スコアを登録する非同期処理を開始します。
DWC_RnkGetScoreAsync ランキングデータを取得する非同期処理を開始します。
DWC_RnkCancelProcess 非同期処理を中断します。
DWC_RnkProcess 非同期処理を更新します。
DWC_RnkGetState 現在の処理状態を取得します。
DWC_RnkResGetRow 通信結果からランキングリストの指定したインデックスの行を取得します。
DWC_RnkResGetRowCount 通信結果からランキングリストの行数を取得します。
DWC_RnkResGetOrder 通信結果から順位を取得します。
DWC_RnkResGetTotal 通信結果の順位の母数を取得します。

構造体

DWCRnkData スコア情報格納用構造体
DWCRnkGetParam_order 順位取得モードで指定するパラメータ
DWCRnkGetParam_toplist トップランキングリスト取得モードで指定するパラメータ
DWCRnkGetParam_nearby 周辺ランキングリスト取得モードで指定するパラメータ
DWCRnkGetParam_friends 友達ランキングリスト取得モードで指定するパラメータ
DWCRnkGetParam DWC_RnkGetScoreAsyncで指定するパラメータ

定数、マクロ、列挙型

こちらを参照してください。

ダウンロード

全般

DWCNdCallback ダウンロードライブラリの各種非同期処理が完了したときに呼び出されるコールバック関数です。
DWC_NdInitAsync ダウンロードライブラリの初期化処理を開始します。
DWC_NdProcess ダウンロードライブラリの処理を進めます。
DWC_NdCleanupAsync ダウンロードライブラリの終了処理を開始します。
DWC_NdSetAttr ダウンロードサーバとの通信に必要な属性情報の設定を行います。
DWC_NdGetFileListNumAsync 現在設定されている属性に対応するダウンロード可能ファイル数を取得します。
DWC_NdGetFileListAsync 現在設定されている属性に対応するファイルリストを取得します。
DWC_NdGetFileAsync DWC_NdGetFileListAsync関数で取得したファイル情報を指定してダウンロードを開始します。
DWC_NdCancelAsync 現在実行中の非同期処理を中断します。
DWC_NdGetProgress 現在実行中のダウンロードの進行状況を取得します。

構造体

DWCNdFileInfo 個々のファイル情報を格納する構造体です。

定数、マクロ、列挙型

こちらを参照してください。

不正文字列チェック

全般

DWC_CheckProfanityAsync 不正文字列チェック処理を開始します。
DWC_CheckProfanityExAsync 対象のリージョンを指定した不正文字列チェック処理を開始します。
DWC_CheckProfanityProcess 不正文字列チェック処理を進行させます。

定数、マクロ、列挙型

こちらを参照してください。