次の方法で共有

IDirectPlay8Peer::DestroyPeer メソッド

  • [アーティクル]

IDirectPlay8Peer::DestroyPeer メソッド

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

構文

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

パラメータ

  • dpnidClient
    [in] 削除するピアの識別子を指定する DPNID 型の変数。
  • pDestroyInfo
    [in] 詳細な削除データ情報を記述する値へのポインタ。
  • dwDestroyInfoSize
    [in] pDestroyInfo パラメータに保持されるデータのサイズを指定する DWORD 型の変数。
  • dwFlags
    [in] 予約済み。0 でなければならない。

戻り値

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

DPNERR_INVALIDPARAM メソッドに渡された 1 つ以上のパラメータが無効である。
DPNERR_INVALIDPLAYER プレーヤ ID が、このゲーム セッションに対する有効なプレーヤ ID として認識されていない。
DPNERR_NOTHOST クライアントがホスト以外のコンピュータに接続しようとした。また、ホスト以外のコンピュータがアプリケーションの記述を設定しようとした場合に、このエラー値を返すことがある。

注意

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