IDirectPlay8Server::GetGroupContext メソッド

  • [アーティクル]

IDirectPlay8Server::GetGroupContext メソッド

グループに対するグループ コンテキスト値を取得する。

構文

HRESULT GetGroupContext(      
    const DPNID dpnid,
    PVOID *const ppvGroupContext,
    const DWORD dwFlags
);

パラメータ

  • dpnid
    [in] グループの識別子を指定する DPNID 型の変数。このグループのコンテキスト データを取得する。
  • ppvGroupContext
    [out] グループのコンテキスト値へのポインタ。
  • dwFlags
    [in] 予約済み。0 でなければならない。

戻り値

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

DPNERR_INVALIDGROUP グループ ID が、このゲーム セッションに対する有効なグループ ID として認識されていない。
DPNERR_INVALIDPARAM メソッドに渡された 1 つあるいは複数のパラメータが無効である。
DPNERR_NOTREADY オブジェクトを使う準備ができていない。

注意

グループのコンテキスト値は、DPN_MSGID_CREATE_GROUP システム メッセージの pvGroupContext メンバをコンテキスト値のデータに示すことによって設定される。

Microsoft® DirectPlay® が dpnid に指定されたグループに対する DPN_MSGID_CREATE_GROUP メッセージを受け取る前にこのメソッドを呼び出すと、このメソッドは DPNERR_NOTREADY を返す。メッセージを保持するスレッドが戻れるようにするため、IDirectPlay8Server::GetGroupContext をもう一度呼び出してタスク切り替えを可能にすること。