Platform SDK: DirectX

IDirectPlay4::SetPlayerName

IDirectPlay4::SetPlayerName メソッドは、ローカル プレーヤーの作成後にその名前を設定する。プレーヤーの名前を設定できるのは、それを作成したコンピュータのみである。セッション記述で DPSESSION_NODATAMESSAGES が設定されている場合を除き、その他すべてのプレーヤーに、変更を知らせる DPMSG_SETPLAYERORGROUPNAME システム メッセージが送信される。

HRESULT SetPlayerName(
  DPID idPlayer,
  LPDPNAME lpPlayerName,
  DWORD dwFlags
);

パラメータ

idPlayer
データを送信するローカル プレーヤーの ID。
lpPlayerName
プレーヤーの名前情報が格納されている DPNAME 構造体へのポインタ。プレーヤーに名前情報がない場合は、このパラメータに NULL を設定する。
dwFlags
名前の伝播方法を示すフラグ。次のいずれかの値を指定できる。
DPSET_GUARANTEED
保証付きメッセージ方式 (可能な場合) によりデータを伝播する。
DPSET_LOCAL
データはその他のプレーヤーに伝播されない。
DPSET_REMOTE
保証なしメッセージ方式で、セッション内のすべてのプレーヤーにデータを伝播する。これがデフォルト値である。

戻り値

成功した場合は DP_OK を返す。失敗した場合は、次のエラー値のいずれかを返す。

DPERR_CONNECTIONLOST
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER

必要条件

  Windows NT/2000 : Windows 2000 が必要。
  Windows 95/98 : Windows 95 以降が必要。Windows 95 用に再配布可能な形で使用可能。
  ヘッダー : dplay.h で宣言。
  インポート ライブラリ : dplayx.lib を使用。

参照

DPNAMEDPMSG_SETPLAYERORGROUPNAMEIDirectPlay4::GetPlayerNameIDirectPlay4::Send