Функция SetupDiSetClassInstallParamsA (setupapi.h)

Статья
08/26/2023

Функция 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.

Побочным эффектом задания параметров установки класса является то, что установлен флаг DI_CLASSINSTALLPARAMS. Если вызывающий объект хочет задать параметры, но отключить их использование, этот флаг должен быть снят вызовом SetupDiSetDeviceInstallParams.

Если параметры установки класса сняты, флаг DI_CLASSINSTALLPARAMS сбрасывается.

Примечание

Заголовок setupapi.h определяет SetupDiSetClassInstallParams в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования


Минимальная версия клиента	Доступно в Microsoft Windows 2000 и более поздних версиях Windows.
Целевая платформа	Персональный компьютер
Верхняя часть	setupapi.h (включая Setupapi.h)
Библиотека	Setupapi.lib

См. также раздел

SetupDiGetClassInstallParams

SetupDiSetDeviceInstallParams

Share via