SetupDiGetClassDescriptionExA 函数 (setupapi.h)

  • 项目

SetupDiGetClassDescriptionEx 函数检索本地或远程计算机上安装的安装程序类的说明。

语法

WINSETUPAPI BOOL SetupDiGetClassDescriptionExA(
  [in]            const GUID *ClassGuid,
  [out]           PSTR       ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize,
  [in, optional]  PCSTR      MachineName,
                  PVOID      Reserved
);

参数

[in] ClassGuid

指向要检索其说明的安装程序类的 GUID 的指针。

[out] ClassDescription

指向接收类说明的字符缓冲区的指针。

[in] ClassDescriptionSize

ClassDescription 参数指向的缓冲区的大小（以字符为单位）。 以 NULL 结尾的类说明的最大长度（以字符为单位）LINE_LEN。 有关详细信息，请参阅以下 “备注” 部分。

[out, optional] RequiredSize

指向 DWORD 类型的变量的指针，该变量接收大小（以字符为单位）的存储所请求的 NULL 终止类说明所需的大小。 此指针是可选的，可以为 NULL。

[in, optional] MachineName

指向以 NULL 结尾的字符串的指针，该字符串提供安装程序类所在的远程计算机的名称。 此指针是可选的，可以为 NULL。 如果类安装在本地计算机上，请将指针设置为 NULL。

注意

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

Reserved

预留给系统使用。 此函数的调用方必须将此参数设置为 NULL。

返回值

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

注解

如果 类的注册表项中存在友好名称，则此例程将返回友好名称。 否则，此例程将返回类名。

SetupDiGetClassDescriptionEx 不对其可返回的类说明的长度强制实施限制。 此函数返回以 NULL 结尾的类说明所需的大小，即使它大于 LINE_LEN。 但是，LINE_LEN是有效以 NULL 结尾的类说明的最大长度。 调用方永远不需要大于 LINE_LEN 的缓冲区。

注意

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

要求

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

另请参阅

SetupDiBuildClassInfoList

SetupDiBuildClassInfoListEx

SetupDiGetDeviceInfoListDetail

SetupDiGetINFClass