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


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

Функция 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 или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

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

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

SetupDiGetHwProfileFriendlyNameEx

SetupDiGetHwProfileList