DWC_CreateFriendKeyToken

構文

#include <dwc.h>
void DWC_CreateFriendKeyToken(DWCFriendData *token,
                              u64 friend_key);

引数

token 友達リストに入れるための友達情報を格納するバッファへのポインタ
friend_key 友達登録鍵

返り値

なし

説明

友達登録鍵から友達リストに入れるための友達情報を作成します。相手に渡す友達登録鍵は、DWC_CreateFriendKey関数で作成してください。

本関数で友達情報を作成する際は、必ず事前にDWC_CheckFriendKey関数で友達登録鍵の正当性を確認してください。

友達情報を友達リストに登録するときは、なるべく重複データを登録しないようにするために、友達リスト中の全友達情報に対してDWC_IsEqualFriendData関数で同じものでないことを確認した後、DWC_IsValidFriendData関数で有効なデータが入っていないところを探して、取得した友達情報を友達リストへ直接コピーしてください。

友達情報を友達リストから削除したいときは、DWC_DeleteBuddyFriendData関数を呼び出して下さい。オフライン中であれば単純に友達情報が0でクリアされ、次回DWC_UpdateServersAsync関数呼び出し時にGameSpyサーバ上の友達関係も削除されます。オンライン中であれば、友達情報が0でクリアされ、即座にGameSpyサーバ上の友達関係も削除されます。

友達リストは、GameSpyサーバからのリクエストにより、オンライン中に自動的に変更される場合があります。そのため、オンライン中に友達リストを編集する場合は、DWC_CanChangeFriendList関数で、編集可能かどうかを確認してください。

オンライン中に友達リストを編集し、友達関係設立処理を行いたい場合は、DWC_UpdateServersAsync関数を呼び出してください。

注意:NITRO-DWC3.0から友達登録鍵の正当性確認に使用されるチェック値の生成方法が変更されたため過去のバージョンのNITRO-DWCで生成した友達登録鍵と互換性がありません。特別な理由で過去の友達登録鍵を扱う必要がある場合は、DWC_CreateFriendKeyLegacy関数とDWC_CheckFriendKeyLegacy関数をご使用ください。

参照

DWC_CreateExchangeToken DWC_CheckFriendKey DWC_CreateFriendKey DWC_IsEqualFriendData DWC_IsValidFriendData DWC_DeleteBuddyFriendData DWC_CanChangeFriendList DWC_UpdateServersAsync

履歴

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