Функция 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
Указатель на структуру 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 (включая Setupapi.h) |
Библиотека | Setupapi.lib |