次の方法で共有


IDirectPlay8Peer::RemovePlayerFromGroup メソッド

IDirectPlay8Peer::RemovePlayerFromGroup メソッド

グループからピアを削除する。

このメソッドを呼び出すと、アプリケーションに接続されているすべてのピアが DPN_MSGID_REMOVE_PLAYER_FROM_GROUP メッセージを受け取る。

構文

HRESULT RemovePlayerFromGroup(      
    const DPNID idGroup,
    const DPNID idClient,
    PVOID const pvAsyncContext,
    DPNHANDLE *const phAsyncHandle,
    const DWORD dwFlags
);

パラメータ

  • idGroup
    [in] ピアが削除されるグループの識別子を指定する DPNID 型の変数。
  • idClient
    [in] グループから削除されるピアの識別子を指定する DPNID 型の変数。
  • pvAsyncContext
    [in] ユーザー指定のコンテキストへのポインタ。これは、DPN_MSGID_ASYNC_OP_COMPLETE システム メッセージの pvUserContext メンバに返される。
  • phAsyncHandle
    [out] DPNHANDLE。値が返される。ただし、Microsoft® DirectPlay® ではこの操作の取り消しは許可されていないため、値を使うことはできない。
  • dwFlags
    [in] このメソッドが処理される方法を制御するフラグ。このメソッドには、次のフラグを設定できる。
    • DPNREMOVEPLAYERFROMGROUP_SYNC
      メソッドを同期をとりながら処理する。

戻り値

メソッドが同期をとりながら処理され、処理が成功した場合は S_OK を返す。デフォルトでは、このメソッドは非同期に実行され、通常の場合、DPNSUCCESS_PENDING を返す。また、次のいずれかのエラー値を返す場合もある。

DPNERR_INVALIDFLAGS このメソッドに渡されたフラグは無効である。
DPNERR_INVALIDGROUP グループ ID が、このゲーム セッションに対する有効なグループ ID として認識されていない。
DPNERR_INVALIDPLAYER プレーヤ ID が、このゲーム セッションに対する有効なプレーヤ ID として認識されていない。
DPNERR_PLAYERNOTINGROUP プレーヤ ID はグループに含まれていない。