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

Статья
11/20/2024

Функция SetupDiGetHwProfileFriendlyName извлекает понятное имя, связанное с идентификатором профиля оборудования.

Синтаксис

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize
);

Параметры

[in] HwProfile

Идентификатор профиля оборудования, связанный с понятным именем для получения. Если этот параметр равен 0, извлекается понятное имя текущего профиля оборудования.

[out] FriendlyName

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

[in] FriendlyNameSize

Размер в символах буфера FriendlyName.

[out, optional] RequiredSize

Указатель на переменную типа DWORD, которая получает количество символов, необходимых для получения понятного имени (включая терминатор NULL).

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

Функция возвращает TRUE, если она выполнена успешно. В противном случае возвращается FALSE и ошибка журнала может быть получена путем вызова GetLastError.

Замечания

Вызовите SetupDiGetHwProfileFriendlyNameEx, чтобы получить понятное имя идентификатора профиля оборудования на удаленном компьютере.

Заметка

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

Требования

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

См. также

SetupDiGetHwProfileFriendlyNameEx

SetupDiGetHwProfileList

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