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

Статья
11/20/2024

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 определяет SetupDiSetClassInstallParams как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Доступно в Microsoft Windows 2000 и более поздних версиях Windows.
целевая платформа	Настольный
заголовка	setupapi.h (include Setupapi.h)
библиотеки	Setupapi.lib

См. также

SetupDiGetClassInstallParams

SetupDiSetDeviceInstallParams

Поделиться через