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

Статья
03/15/2023

Функция SetupDiGetHwProfileListEx извлекает список всех определенных в настоящее время идентификаторов профилей оборудования на локальном или удаленном компьютере.

Синтаксис

WINSETUPAPI BOOL SetupDiGetHwProfileListExA(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

Параметры

[out] HwProfileList

Указатель на массив для получения списка определенных в настоящее время идентификаторов профилей оборудования.

[in] HwProfileListSize

Количество DWORD в буфере HwProfileList .

[out] RequiredSize

Указатель на переменную типа DWORD, которая получает количество профилей оборудования, определенных в данный момент. Если число больше , чем HwProfileListSize, список усекается в соответствии с размером массива. Значение, возвращаемое в поле RequiredSize , указывает размер массива, необходимый для хранения всего списка профилей оборудования.

[out, optional] CurrentlyActiveIndex

Указатель на переменную, которая получает индекс активного в настоящее время профиля оборудования в списке извлеченных профилей оборудования. Этот параметр является необязательным и может иметь значение NULL.

[in, optional] MachineName

Указатель на строку, завершающуюся значением NULL, которая содержит имя удаленной системы, для которой требуется получить список идентификаторов профилей оборудования. Этот параметр является необязательным и может иметь значение NULL. Если этот параметр имеет значение NULL, список извлекается для локальной системы.

Внимание!

Использование этой функции для доступа к удаленным компьютерам не поддерживается начиная с Windows 8 и Windows Server 2012, так как эта функция была удалена.

Reserved

Должен иметь значение NULL.

Возвращаемое значение

Функция возвращает значение TRUE в случае успешного выполнения. В противном случае возвращается значение FALSE , а зарегистрированная ошибка может быть получена путем вызова Метода GetLastError. Если требуемый размер больше HwProfileListSize, SetupDiGetHwProfileListEx возвращает значение FALSE , а вызов GetLastError возвращает ERROR_INSUFFICIENT_BUFFER.

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

Требования

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

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

SetupDiGetHwProfileFriendlyNameEx

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