Microsoft DirectX 8.0 (C++)

IDirectPlay8Peer::GetGroupInfo

グループ名など、グループに関連付けられているデータのブロックを取得する。

通常、グループ データが変更されたことを示す DPN_MSGID_GROUP_INFO システム メッセージが受信された後、このメソッドが呼び出される。

HRESULT GetGroupInfo(
const DPNID dpnid,
DPN_GROUP_INFO *const pdpnGroupInfo,
DWORD *const pdwSize,
const DWORD dwFlags
);

パラメータ

dpnid
データ ブロックを取得するグループの識別子を指定する DPNID 型の変数。
pdpnGroupInfo
グループ データを記述する DPN_GROUP_INFO 構造体へのポインタ。pdwSize が NULL に設定されていない場合、pdpnGroupInfo.dwSize に DPN_GROUP_INFO 構造体のサイズを設定する必要がある。
pdwSize
データのサイズを pdpnGroupInfo パラメータに返す DWORD 型の変数へのポインタ。バッファが小さすぎる場合、このメソッドは DPNERR_BUFFERTOOSMALL を返す。このパラメータには、必要なサイズが設定される。
dwFlags
予約済み。0 に設定する。

戻り値

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

DPNERR_BUFFERTOOSMALL
DPNERR_INVALIDFLAGS
DPNERR_INVALIDGROUP

注意

Microsoft® DirectPlay® は DPN_GROUP_INFO 構造体と、連続するバッファにある、この構造体の pwszName メンバと pvData メンバに割り当てられたポインタを返す。この 2 つのポインタが設定される場合、構造体に加えて 2 つのポインタにも十分なメモリを割り当てておく必要がある。このメソッドを使用する最も確実な方法は、最初は pdwSize を NULL に設定してこのメソッドを呼び出すことである。メソッドが戻ると、pdwSize が正しい値をポイントしている。その値を使って構造体のメモリを再割り当てし、もう一度メソッドを呼び出して情報を取得する。

メソッドが戻ると、対応するポインタが NULL に設定されている場合でも、DPN_GROUP_INFO 構造体の dwInfoFlags メンバには常に DPNINFO_DATA フラグと DPNINFO_NAME フラグが設定されている。これらのフラグは IDirectPlay8Peer::SetGroupInfo を呼び出すときに使用され、DirectPlay に変更された値を通知する。

IDirectPlay8Peer::SetGroupInfo メソッドを使用すると処理に負担がかかるため、非静的情報は IDirectPlay8Peer::SendTo メソッドを使用して転送すること。

動作環境

  Windows NT/2000 : Windows 2000 以降に対する再配布可能ファイルとして提供。
  Windows 95/98 : Windows 95 以降に対する再配布可能ファイルとして提供。
  ヘッダー : Dplay8.h で宣言。