Microsoft DirectX 8.0 (C++)

IDirectPlay8Peer::DestroyPeer

セッションからピアを削除する。

HRESULT DestroyPeer(
const DPNID dpnidClient,
void *const pDestroyInfo,
const DWORD dwDestroyInfoSize,
const DWORD dwFlags
);

パラメータ

dpnidClient
削除するピアの識別子を指定する DPNID 型の変数。
pDestroyInfo
詳細な削除データ情報を記述する値へのポインタ。
dwDestroyInfoSize
pDestroyInfo パラメータに保持されるデータのサイズを指定する DWORD 型の変数。
dwFlags
予約済み。0 に設定しておく。

戻り値

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

DPNERR_INVALIDPARAM
DPNERR_INVALIDPLAYER
DPNERR_NOTHOST

注意

プレーヤーを削除できるのは、セッション ホストのみである。削除されたプレーヤーは、DPN_MSGID_TERMINATE_SESSION メッセージによって通知される。メッセージに関連付けられている構造体には、pDestroyInfo パラメータによって渡されるデータが格納される。ほかのセッション メンバがこのメソッドを呼び出すと、メソッドは失敗し、DPNERR_NOTHOST を返す。

動作環境

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