Platform SDK: DirectX

DirectPlay4.DestroyPlayer

DirectPlay4.DestroyPlayer メソッドは、セッションからローカル プレーヤーを削除し、そのプレーヤーに対する保留中のメッセージを送信キューから削除し、そのプレーヤーが属するすべてのグループからそのプレーヤーを削除する。

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

object.DestroyPlayer(playerId As Long) 

パラメータ

object
DirectPlay4 オブジェクトを表すオブジェクト式。
playerId
セッションから削除する、ローカルに保持されるプレーヤーの ID。セッションのホストが DestroyPlayer を呼び出す場合、この ID は、ローカルまたはリモートに関係なく、任意のプレーヤーの ID でよい。

エラー コード

失敗すればエラーが発生し、Err.Number に次のいずれかの値が設定される。

DPERR_ACCESSDENIED
DPERR_CONNECTIONLOST
DPERR_INVALIDOBJECT
DPERR_INVALIDPLAYER
DPERR_UNAVAILABLE

注意

このメソッドは、プレーヤーが属する各グループに対して DPSYS_DELETEPLAYERFROMGROUP システム メッセージを生成し、さらに DPSYS_DESTROYPLAYERORGROUP システム メッセージを生成する。

プレーヤーに対する非同期メッセージが送信キュー内で保留状態になっていると、そのプレーヤーを破棄することはできない。このメソッドは、削除するプレーヤーに対する保留中のメッセージを、

プレーヤー ID は、現在のセッションが継続している間は、再利用されない。

参照

DirectPlay4.CreatePlayer