Microsoft DirectX 8.0 (C++)

IDirectPlay8LobbyClient::EnumLocalPrograms

システムに登録されているロビー アプリケーションを列挙する。

HRESULT EnumLocalPrograms(
GUID *const pGuidApplication,
BYTE *const pEnumData,
DWORD *const pdwEnumData,
DWORD *const pdwItems.
const DWORD dwFlags
);

パラメータ

pGuidApplication
列挙するロビー アプリケーションを指定する GUID 型の変数へのポインタ。このパラメータはオプションである。NULL を渡すと、利用可能なすべてのロビー アプリケーションが列挙される。
pEnumData
ロビー アプリケーションの記述を格納する BYTE 型の変数へのポインタ。
pdwEnumData
pEnumData バッファに保持されるバイト数を指定する DWORD 型の変数へのポインタ。pEnumData のバッファが小さすぎる場合、このメソッドは DPNERR_BUFFERTOOSMALL を返し、必要なバッファのサイズをこのパラメータに設定する。
pdwItems
pEnumData バッファの DPL_APPLICATION_INFO 構造体の数を保持する DWORD 型の変数へのポインタ。メソッドが成功した場合にのみ、このパラメータに値が格納される。
dwFlags
予約済み。0 に設定しておく。

戻り値

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

DPNERR_BUFFERTOOSMALL
DPNERR_INVALIDFLAGS
DPNERR_INVALIDPARAM

注意

通常、このメソッドは 2 回呼び出される。1 回目は、必要なバッファのサイズを取得するために呼び出される。2 回目は、正しいバッファ サイズを使用して呼び出される。

動作環境

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