DWC_GetOwnStatusString

構文

#include <dwc.h>
BOOL DWC_GetOwnStatusString(char *statusString);

引数

statusString status文字列格納先ポインタ。最大DWC_FRIEND_STATUS_STRING_LEN文字(NULL終端含む)。

返り値

TRUE 取得成功
FALSE ログイン前などで取得失敗

説明

現在の自分の通信状態のうち、status文字列を取得します。

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

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

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

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

履歴

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