Microsoft DirectX 8.0 (C++)

IDirectPlay8Peer::DestroyGroup

IDirectPlay8Peer::CreateGroup メソッドによって作成されたグループを削除する。このメソッドは、セッション内の任意のピアから呼び出すことができる。

HRESULT DestroyGroup(
const DPNID idGroup,
PVOID const pvAsyncContext,
DPNHANDLE *const phAsyncHandle,
const DWORD dwFlags
);

パラメータ

idGroup
DPNID 型の変数。削除するグループの識別子を設定する。
pvAsyncContext
ユーザー指定のコンテキストへのポインタ。これは、DPN_MSGID_ASYNC_OP_COMPLETE システム メッセージの pvUserContext メンバに返される。このパラメータはオプションであり、NULL に設定できる。
phAsyncHandle
A DPNHANDLE.値が返される。ただし、Microsoft® DirectPlay® 8.0 ではこの操作の取り消しは許可されていないため、値を使用することはできない。
dwFlags
このメソッドが処理される方法を制御するフラグ。このメソッドには、次のフラグを設定できる。
DPNDESTROYGROUP_SYNC
メソッドを同期をとりながら処理する。

戻り値

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

DPNERR_INVALIDFLAGS
DPNERR_INVALIDGROUP

動作環境

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