Microsoft DirectX 8.0 (C++)

IDirectPlay8Peer::SetGroupInfo

グループ名など、グループに関連するデータのブロックを設定する。

このメソッドを呼び出すと、DPN_MSGID_GROUP_INFO メッセージが生成される。このメッセージは、アプリケーションに接続されているすべてのピアに送信される。

HRESULT SetGroupInfo(
const DPNID dpnid,
DPN_GROUP_INFO *const pdpnGroupInfo,
PVOID const pvAsyncContext,
DPNHANDLE *const phAsyncHandle,
const DWORD dwFlags
);

パラメータ

dpnid
データ ブロックを変更するグループの識別子を指定する DPNID 型の変数。
pdpnGroupInfo
設定するグループ データを記述する DPN_GROUP_INFO 構造体へのポインタ。pwszName または pvData メンバの値を変更するには、対応する DPNINFO_NAME フラグまたは DPNINFO_DATA フラグを dwInfoFlags メンバを設定する必要がある。
pvAsyncContext
ユーザー指定のコンテキストへのポインタ。これは、DPN_MSGID_ASYNC_OP_COMPLETE システム メッセージの pvUserContext メンバに返される。
phAsyncHandle
DPNHANDLE。値が返される。ただし、Microsoft® DirectPlay® 8.0 ではこの操作の取り消しは許可されていないため、値を使用することはできない。
dwFlags
このメソッドが処理される方法を制御するフラグ。このメソッドには、次のいずれかの値を設定できる。
DPNSETGROUPINFO_SYNC
メソッドを同期をとりながら処理する。

戻り値

メソッドが同期をとりながら処理され、処理が成功した場合は S_OK を返す。デフォルトでは、このメソッドは非同期に実行され、通常の場合、DPNSUCCESS_PENDING を返す。また、次のいずれかのエラー値を返す場合もある。

DPNERR_INVALIDFLAGS
DPNERR_INVALIDGROUP

注意

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

動作環境

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