Platform SDK: DirectX |
DirectPlay4.DestroyGroup メソッドは、セッションからグループを削除する。
object.DestroyGroup(GroupId As Long)
失敗すればエラーが発生し、Err.Number に次のいずれかの値が設定される。
DPERR_CONNECTIONLOST |
DPERR_INVALIDGROUP |
DPERR_INVALIDOBJECT |
DPERR_INVALIDPARAMS |
DPERR_INVALIDPLAYER |
グループは、削除する前に空である必要はない。削除するグループに属する個々のプレーヤーは、破棄されない。
このメソッドは、グループ内の各プレーヤーに対して、DPSYS_DELETEPLAYERFROMGROUP システム メッセージを生成し、さらに DPSYS_DESTROYPLAYERORGROUP システム メッセージを生成する。
グループがローカルに作成されたものでない場合でも、任意のアプリケーションで任意のグループを破棄することができる。
破棄するグループの ID は、現在のセッションが継続している間は、再利用されない。