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

Статья
11/20/2024

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

Указатель на структуру SP_DEVINFO_DATA, которая указала элемент сведений об устройстве в DeviceInfoSet. Этот параметр является необязательным и может быть 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.

Замечания

Параметры установки класса относятся к определенному коду функции установки устройства , который хранится в поле ClassInstallHeader, расположенном в начале буфер а ClassInstallParams.

Заметка

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

Требования

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

См. также

SetupDiSetClassInstallParams

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