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

Статья
11/20/2024

Функция 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 (include Setupapi.h)
библиотеки	Setupapi.lib

См. также

SetupDiGetHwProfileFriendlyNameEx

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