SetupDiSetClassInstallParamsA 関数 (setupapi.h)

  • [アーティクル]

SetupDiSetClassInstallParams 関数は、デバイス情報セットまたは特定のデバイス情報要素のクラス インストール パラメーターを設定またはクリアします。

構文

WINSETUPAPI BOOL SetupDiSetClassInstallParamsA(
  [in]           HDEVINFO                DeviceInfoSet,
  [in, optional] PSP_DEVINFO_DATA        DeviceInfoData,
  [in, optional] PSP_CLASSINSTALL_HEADER ClassInstallParams,
  [in]           DWORD                   ClassInstallParamsSize
);

パラメーター

[in] DeviceInfoSet

クラス インストール パラメーターを 設定するデバイス情報セット へのハンドル。

[in, optional] DeviceInfoData

クラス インストール パラメーターを設定するデバイスを表す SP_DEVINFO_DATA 構造体へのポインター。 このパラメーターは省略可能であり、 NULL にすることができます。 このパラメーターを指定すると、 SetupDiSetClassInstallParams は 、指定したデバイスのクラス インストール パラメーターを設定します。 このパラメーターが NULL の場合、 SetupDiSetClassInstallParams は DeviceInfoSet に関連付けられているクラス インストール パラメーターを設定します。

[in, optional] ClassInstallParams

使用する新しいクラス インストール パラメーターを含むバッファーへのポインター。 このバッファーの先頭にある SP_CLASSINSTALL_HEADER 構造体には 、cbSize フィールドを sizeof(SP_CLASSINSTALL_HEADER) に設定し、 InstallFunction フィールドを、バッファーの残りの部分に含まれるパラメーターの型を反映するDI_FUNCTION コードに設定する必要があります。

ClassInstallParams が指定されていない場合、現在のクラス インストール パラメーターがある場合は、指定したデバイス情報セットまたは要素に対してクリアされます。

[in] ClassInstallParamsSize

ClassInstallParams バッファーのサイズ (バイト単位)。 バッファーが指定されていない場合 (つまり、クラスのインストール パラメーターがクリアされています)、 ClassInstallParamsSize は 0 である必要があります。

戻り値

成功した場合、関数は TRUE を 返します。 それ以外の場合は FALSE を 返し、ログに記録されたエラーを GetLastError の呼び出しで取得できます。

解説

すべてのパラメーターは、変更が行われる前に検証されます。 したがって、 FALSE の戻り値は、パラメーターが変更されなかったことを示します。

クラス インストール パラメーターを設定する場合の副作用は、DI_CLASSINSTALLPARAMS フラグが設定されていることです。 呼び出し元がパラメーターを設定するが、その使用を無効にする場合は、 SetupDiSetDeviceInstallParams の呼び出しによってこのフラグをクリアする必要があります。

クラスのインストール パラメーターがクリアされると、DI_CLASSINSTALLPARAMS フラグがリセットされます。

注意

setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupDiSetClassInstallParams を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Microsoft Windows 2000 以降のバージョンの Windows で使用できます。
対象プラットフォーム デスクトップ
Header setupapi.h (Setupapi.h を含む)
Library Setupapi.lib

関連項目

SetupDiGetClassInstallParams

SetupDiSetDeviceInstallParams