DWC_SetOwnStatusString

構文

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

引数

statusString status文字列にセットする文字列。DWC_FRIEND_STATUS_STRING_LEN文字(NULL終端含む)まで。
これ以上の長さの文字列を指定した場合は、DWC_FRIEND_STATUS_STRING_LEN文字以降が切り捨てられます。

返り値

TRUE セット成功
FALSE ログイン前などの理由でセット失敗

説明

自分の通信状態のうち、status文字列をセットします。

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

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

セットされた文字列は、他のホストからDWC_GetFriendStatus*関数で取得することができます。

'/'と'\'は識別文字としてライブラリが使うので、status文字列中に使用しないで下さい。これらの文字列を使用したい場合は、DWC_SetOwnStatusData関数を用いて、バイナリデータとして保存してください。

セットされた文字列は、DWC_ShutdownFriendsMatch関数を呼び出した時にクリアされます。

履歴

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