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)
Setupapi.lib

另请参阅

SetupDiGetHwProfileFriendlyNameEx

SetupDiGetHwProfileList