IDirectPlay8Client::GetServerInfo メソッド

IDirectPlay8Client::GetServerInfo メソッド

IDirectPlay8Server::SetServerInfo メソッドの呼び出しによって設定されたサーバーのデータ セットを取得する。

構文

HRESULT GetServerInfo(      
    DPN_PLAYER_INFO *const pdpnPlayerInfo,
    DWORD *const pdwSize,
    const DWORD dwFlags
);

パラメータ

• pdpnPlayerInfo
  [out] サーバーの情報を格納する DPN_PLAYER_INFO 構造体へのポインタ。pdwSize が NULL に設定されていない場合、 pdpnPlayerInfo.dwSize に DPN_PLAYER_INFO 構造体のサイズを設定しなければならない。
• pdwSize
  [out] pdpnPlayerInfo パラメータに返されるデータのサイズを保持する DWORD 型の変数へのポインタ。この値が小さすぎる場合、このメソッドは DPNERR_BUFFERTOOSMALL を返す。このパラメータには、必要なバッファ サイズが設定される。
• dwFlags
  [in] 予約済み。0 でなければならない。

戻り値

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

DPNERR_BUFFERTOOSMALL	指定されたバッファが小さすぎて、要求されたデータを格納できない。
DPNERR_INVALIDPARAM	メソッドに渡された 1 つ以上のパラメータが無効である。

注意

このメソッドは、サーバーが情報を更新したことを示す、DPN_MSGID_SERVER_INFO メッセージをクライアントが受け取った後で呼び出す。

Microsoft® DirectPlay® は DPN_PLAYER_INFO 構造体と、連続するバッファにある、この構造体の pwszName メンバと pvData メンバに割り当てられたポインタを返す。この 2 つのポインタが設定される場合、構造体に加えて 2 つのポインタにも十分なメモリを割り当てておく必要がある。このメソッドを使う最も確実な方法は、最初は pdwSize を NULL に設定してこのメソッドを呼び出すことである。メソッドが戻ると、pdwSize が正しい値をポイントしている。その値を使って構造体のメモリを再割り当てし、もう一度メソッドを呼び出して情報を取得する。

メソッドが戻ると、対応するポインタが NULL に設定されている場合でも、DPN_PLAYER_INFO 構造体の dwInfoFlags メンバには常に DPNINFO_DATA フラグと DPNINFO_NAME フラグが設定されている。これらのフラグは IDirectPlay8Server::SetServerInfo を呼び出すときに使われ、DirectPlay に変更された値を通知する。

IDirectPlay8Server::SetServerInfo メソッドを使うと処理に負担がかかるため、非静的情報は IDirectPlay8Server::SendTo メソッドを使って転送すること。