SetupDiGetHwProfileFriendlyNameA 函数 (setupapi.h)

  • 项目

SetupDiGetHwProfileFriendlyName 函数检索与硬件配置文件 ID 关联的友好名称。

语法

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

参数

[in] HwProfile

与要检索的友好名称关联的硬件配置文件 ID。 如果此参数为 0，则检索当前硬件配置文件的友好名称。

[out] FriendlyName

指向要接收友好名称的字符串缓冲区的指针。

[in] FriendlyNameSize

FriendlyName 缓冲区的大小（以字符为单位）。

[out, optional] RequiredSize

指向 DWORD 类型的变量的指针，该变量接收检索友好名称所需的字符数 (包括 NULL 终止符) 。

返回值

如果成功，该函数将返回 TRUE 。 否则，它将返回 FALSE ，并且可以通过调用 GetLastError 来检索记录的错误。

注解

调用 SetupDiGetHwProfileFriendlyNameEx 以获取远程计算机上硬件配置文件 ID 的友好名称。

注意

setupapi.h 标头将 SetupDiGetHwProfileFriendlyName 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 在 Microsoft Windows 2000 及更高版本的 Windows 中可用。
目标平台 桌面
标头 setupapi.h (包括 Setupapi.h)
Library Setupapi.lib

另请参阅

SetupDiGetHwProfileFriendlyNameEx

SetupDiGetHwProfileList