IDirectPlay8Peer::GetPlayerContext メソッド
IDirectPlay8Peer::GetPlayerContext メソッド
指定されたピアのプレーヤのコンテキスト値を取得する。
構文
HRESULT GetPlayerContext(
const DPNID dpnid,
PVOID *const ppvPlayerContext,
const DWORD dwFlags
);
パラメータ
- dpnid
[in] プレーヤの識別子を指定する DPNID 型の変数。このプレーヤのコンテキスト データを取得する。 - ppvPlayerContext
[out] ピアのコンテキスト データへのポインタ。 - dwFlags
[in] 予約済み。0 でなければならない。
戻り値
成功した場合は S_OK を返し、失敗した場合は次のいずれかのエラー値を返す。
DPNERR_INVALIDPARAM | メソッドに渡された 1 つ以上のパラメータが無効である。 |
DPNERR_INVALIDPLAYER | プレーヤ ID が、このゲーム セッションに対する有効なプレーヤ ID として認識されていない。 |
DPNERR_NOTREADY | オブジェクトの使用準備ができていない。 |
注意
プレーヤのコンテキスト値は、DPN_MSGID_CREATE_PLAYER システム メッセージの pvPlayerContext メンバをコンテキスト値のデータに示すことによって設定される。
Microsoft® DirectPlay® が dpnid に指定されたプレーヤに対する DPN_MSGID_CREATE_PLAYER メッセージを受け取る前にこのメソッドを呼び出すと、このメソッドは DPNERR_NOTREADY を返す。メッセージを保持するスレッドが戻れるようにするため、IDirectPlay8Peer::GetPlayerContext をもう一度呼び出してタスク切り替えを可能にすること。