Platform SDK: DirectX

IDirectPlay4::DestroyPlayer

IDirectPlay4::DestroyPlayer メソッドは、ローカル プレーヤーをセッションから削除し、そのプレーヤー宛てのペンディング状態のメッセージをメッセージ キューから削除し、プレーヤーが属するすべてのグループからプレーヤーを削除する。このプレーヤー ID は、カレント セッションで再利用されない。

一般には、プレーヤーを作成したアプリケーションだけがそのプレーヤーを破棄できる。しかし、セッションのホストも、プレーヤーを破棄できる。

HRESULT DestroyPlayer(
  DPID idPlayer
);

パラメータ

idPlayer
ローカルに所有されているプレーヤーで、セッションから削除するプレーヤーのプレーヤー ID。セッションのホストから DestroyPlayer を呼び出す場合は、この ID はローカル プレーヤーの ID でも、リモート プレーヤーの ID でもかまわない。

戻り値

処理が成功した場合は DP_OK を返す。失敗した場合は、次のエラー メッセージのいずれかを返す。

DPERR_ACCESSDENIED
DPERR_CONNECTIONLOST
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER
DPERR_UNAVAILABLE

注意

このメソッドは、プレーヤーが属するグループごとに DPMSG_DELETEPLAYERFROMGROUP システム メッセージを作成してから、DPMSG_DESTROYPLAYERORGROUP システム メッセージを作成する。

プレーヤーの送信キューにペンディング状態の非同期メッセージがある場合、そのプレーヤーは破棄できない。すべてのメッセージを完了するか、または取り消す必要がある。

必要条件

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

参照

IDirectPlay4::CreatePlayerDPMSG_DESTROYPLAYERORGROUP