Platform SDK: DirectX

IDirectPlay4::GetGroupName

IDirectPlay4::GetGroupName メソッドは、グループに関連付けられている名前を返す。

HRESULT GetGroupName(
  DPID idGroup,
  LPVOID lpData,
  LPDWORD lpdwDataSize
);

パラメータ

idGroup
名前が要求されているグループの ID。
lpData
名前データを書き込むバッファへのポインタ。データのサイズのみを要求する場合は、このパラメータに NULL を設定する。lpdwDataSize パラメータはデータを保持するのに必要なサイズに設定される。
lpdwDataSize
このメソッドを呼び出す前に、バッファのサイズに初期化された変数へのポインタ。メソッドが戻ると、このパラメータには名前データのサイズがバイト単位で設定されている。バッファが小さすぎる場合 (DPERR_BUFFERTOOSMALL)、このパラメータには必要なバッファのサイズが設定される。

戻り値

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

DPERR_BUFFERTOOSMALL
DPERR_INVALIDGROUP
DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER

注意

メソッドが戻ったら、ポインタ lpDataDPNAME 構造体にキャストして、グループ名データを読み取る必要がある。

必要条件

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

参照

DPNAMEIDirectPlay4::SetGroupName