SetupDiGetClassInstallParamsA 関数 (setupapi.h)
SetupDiGetClassInstallParams 関数は、デバイス情報セットまたは特定のデバイス情報要素のクラス インストール パラメーターを取得します。
構文
WINSETUPAPI BOOL SetupDiGetClassInstallParamsA(
[in] HDEVINFO DeviceInfoSet,
[in, optional] PSP_DEVINFO_DATA DeviceInfoData,
[out, optional] PSP_CLASSINSTALL_HEADER ClassInstallParams,
[in] DWORD ClassInstallParamsSize,
[out, optional] PDWORD RequiredSize
);
パラメーター
[in] DeviceInfoSet
取得するクラス インストール パラメーターを含む デバイス情報セット へのハンドル。
[in, optional] DeviceInfoData
DeviceInfoSet でデバイス情報要素を指定したSP_DEVINFO_DATA構造体へのポインター。 このパラメーターは省略可能であり、 NULL にすることができます。 このパラメーターを指定すると、 SetupDiGetClassInstallParams は、指定したデバイスのクラス インストール パラメーターを取得します。 このパラメーターが NULL の場合、 SetupDiGetClassInstallParams は DeviceInfoSet に関連付けられているグローバル クラス ドライバー リストのクラス インストール パラメーターを取得します。
[out, optional] ClassInstallParams
SP_CLASSINSTALL_HEADER構造体を含むバッファーへのポインター。 この構造体には、入力時に cbSize メンバーが sizeof(SP_CLASSINSTALL_HEADER) に設定されている必要があります。または、バッファーが無効と見なされます。 出力時に、 InstallFunction メンバーには、取得されるクラス インストール パラメーターの デバイス インストール関数コード が入力されます。 バッファーが十分な大きさの場合は、関数コードに固有のクラス インストール パラメーター構造も受け取ります。 ClassInstallParams が指定されていない場合、ClassInstallParamsSize は 0 である必要があります。
[in] ClassInstallParamsSize
ClassInstallParams バッファーのサイズ (バイト単位)。 バッファーを指定する場合は、少なくとも sizeof(SP_CLASSINSTALL_HEADER) と同じ大きさにする必要があります。 バッファーが指定されていない場合、 ClassInstallParamsSize は 0 である必要があります。
[out, optional] RequiredSize
クラス インストール パラメーターの格納に必要なバイト数を受け取る DWORD 型の変数へのポインター。 このパラメーターは省略可能であり、 NULL にすることができます。
戻り値
成功した場合、関数は TRUE を 返します。 それ以外の場合は FALSE を 返し、ログに記録されたエラーを GetLastError の呼び出しで取得できます。
注釈
クラス インストール パラメーターは、ClassInstallParams バッファーの先頭にある ClassInstallHeader フィールドに格納されている特定のデバイス インストール関数コードに固有です。
注意
setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupDiGetClassInstallParams を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Microsoft Windows 2000 以降のバージョンの Windows で使用できます。 |
| 対象プラットフォーム | デスクトップ |
| Header | setupapi.h (Setupapi.h を含む) |
| Library | Setupapi.lib |