SetupDiGetHwProfileListExA 函数 (setupapi.h)

SetupDiGetHwProfileListEx 函数检索本地或远程计算机上当前定义的所有硬件配置文件 ID 的列表。

语法

WINSETUPAPI BOOL SetupDiGetHwProfileListExA(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

参数

[out] HwProfileList

指向数组的指针，用于接收当前定义的硬件配置文件 ID 的列表。

[in] HwProfileListSize

HwProfileList 缓冲区中的 DWORD 数。

[out] RequiredSize

指向 DWORD 类型的变量的指针，该变量接收当前定义的硬件配置文件的数量。 如果数字大于 HwProfileListSize，则列表将被截断以适应数组大小。 RequiredSize 中返回的值指示存储整个硬件配置文件列表所需的数组大小。

[out, optional] CurrentlyActiveIndex

指向变量的指针，该变量接收检索到的硬件配置文件列表中当前活动硬件配置文件的索引。 此参数是可选的，可以为 NULL。

[in, optional] MachineName

指向以 NULL 结尾的字符串的指针，该字符串包含要为其检索硬件配置文件 ID 列表的远程系统的名称。 此参数是可选的，可以为 NULL。 如果此参数为 NULL，则为本地系统检索列表。

注意

从Windows 8和Windows Server 2012开始，不支持使用此函数访问远程计算机，因为此功能已被删除。

Reserved

必须为 NULL。

返回值

如果成功，函数将返回 TRUE 。 否则，它将返回 FALSE ，并且可以通过调用 GetLastError 来检索记录的错误。 如果所需大小大于 HwProfileListSize， 则 SetupDiGetHwProfileListEx 返回 FALSE ，对 GetLastError 的调用将返回ERROR_INSUFFICIENT_BUFFER。

注解

注意

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

要求

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

另请参阅

SetupDiGetHwProfileFriendlyNameEx