DWC_GetOwnStatusData

構文

#include <dwc.h>
int DWC_GetOwnStatusData(char *statusData);

引数

statusData statusデータ格納先ポインタ

返り値

0以上 取得したバイナリデータのサイズ
負の値 ログイン前などで取得失敗

説明

現在の自分の通信状態のうち、statusデータ(バイナリデータ)を取得します。

プレイヤーの通信状態は、プレイヤーのオンライン、オフライン等の状態を表すstatusフラグと、status文字列というものから成っており、GameSpyサーバ上で管理されています。本関数では、status文字列をBase64でエンコードされた文字列と見なし、デコードしてstatusデータ(引数statusData)を取得します。statusフラグはDWCライブラリが自動的にセットしますが、statusデータはDWC_SetOwnStatusData関数を用いてアプリケーションが設定することができます。statusフラグの種別についてはDWC_GetFriendStatus関数の返り値の欄を参照してください。

引数statusDataにNULLを指定すると、statusデータのデコードは行わずにバイナリデータのサイズのみを取得できます。

本関数では、DWCライブラリ内に保存されている自分のStatusデータを取得するため、通信は行いません。

この関数を使うためには、DWC_LoginAsync関数によるログインまでを完了させておく必要があります。

バイナリデータではなく文字列を設定/取得したい場合は、DWC_SetOwnStatusString/DWC_GetOwnStatusString関数を使用してください。

履歴

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