Platform SDK: DirectX

IDirectPlay4::SetGroupName

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

HRESULT SetGroupName(
  DPID idGroup,
  LPDPNAME lpGroupName,
  DWORD dwFlags
);

パラメータ

idGroup
名前を設定するグループ ID。
lpGroupName
グループの名前情報が格納されている DPNAME 構造体へのポインタ。グループに名前情報がない場合は、このパラメータに NULL を設定する。
dwFlags
このパラメータに 0 を設定した場合、名前は、保証なしメッセージ方式ですべてのリモート システムに伝播される。この値は、ローカル セッションにより所有されているグループでのみ使用できる。
DPSET_GUARANTEED
保証付きメッセージ方式 (可能な場合) によりデータを伝播する。
DPSET_LOCAL
データはローカルにしか使用されず、伝播されない。
DPSET_REMOTE
このデータは、すべてのアプリケーションにより使用されるので、セッション内のその他すべてのアプリケーションに伝播される。このフラグは、ローカル セッションにより所有されているグループでのみ使用できる。

戻り値

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

DPERR_CONNECTIONLOST
DPERR_INVALIDGROUP
DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER

必要条件

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

参照

DPNAMEDPMSG_SETPLAYERORGROUPNAMEIDirectPlay4::GetGroupNameIDirectPlay4::Send