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

Статья
11/20/2024

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

Синтаксис

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameExA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

Параметры

[in] HwProfile

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

[out] FriendlyName

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

[in] FriendlyNameSize

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

[out, optional] RequiredSize

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

[in, optional] MachineName

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

Осторожность

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

Reserved

Должен быть null.

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

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

Замечания

Заметка

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

Требования

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

См. также

SetupDiGetHwProfileFriendlyName

SetupDiGetHwProfileListEx

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