Microsoft DirectX 8.0 (C++)

IDirectPlay8Client::GetApplicationDesc

接続されているアプリケーションの完全なアプリケーション記述を取得する。

HRESULT GetApplicationDesc(
DPN_APPLICATION_DESC *const pAppDescBuffer,
DWORD *const pcbDataSize,
const DWORD dwFlags
);

パラメータ

pAppDescBuffer
アプリケーションの記述データが書き込まれる DPN_APPLICATION_DESC 構造体へのポインタ。データのサイズのみを要求するときは、このパラメータに NULL を設定する。pAppDescBuffer が NULL に設定されていない場合、pAppDescBuffer.dwSize メンバに適切な値を設定しなければならない。pcbDataSize パラメータは、データの保持に必要なサイズに設定される。
pcbDataSize
このメソッドを呼び出す前に、バッファのサイズに初期化された DWORD 型の変数へのポインタ。メソッドが戻ると、このパラメータにはセッション データのサイズがバイト単位で設定されている。バッファが小さすぎる場合、このメソッドはエラー値 DPNERR_BUFFERTOOSMALL を返す。このパラメータには、必要なバッファ サイズが設定される。このパラメータが NULL の場合、メソッドは DPNERR_INVALIDPARAM を返す。
dwFlags
予約済み。0 に設定しておく。

戻り値

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

DPNERR_BUFFERTOOSMALL
DPNERR_INVALIDFLAGS
DPNERR_INVALIDPARAM
DPNERR_NOCONNECTION

注意

pvData パラメータに NULL を渡して最初にこのメソッドを呼び出し、必要なバッファ サイズを取得する。2 回目にこのメソッドを呼び出してバッファにデータを格納するときは、構造体の dwSize メンバを適切な値に設定する。

返された DPN_APPLICATION_DESC 構造体には、guidInstanceguidApplication、および pwszSessionName メンバが設定されている。この中には、セッションに接続されているほかのクライアントに関する情報は含まれていない。このような情報は、サーバー アプリケーションのみが取得できる。特に、dwCurrentPlayers メンバは必ず 0 に設定する。

動作環境

  Windows NT/2000 : Windows 2000 以降に対する再配布可能ファイルとして提供。
  Windows 95/98 : Windows 95 以降に対する再配布可能ファイルとして提供。
  ヘッダー : Dplay8.h で宣言。