msi.h) (MsiEnumClientsW 函数

  • 项目

MsiEnumClients 函数枚举给定已安装组件的客户端。 每次调用函数时，该函数都会检索一个产品代码。

语法

UINT MsiEnumClientsW(
  [in]  LPCWSTR szComponent,
  [in]  DWORD   iProductIndex,
  [out] LPWSTR  lpProductBuf
);

parameters

[in] szComponent

指定要枚举其客户端的组件。

[in] iProductIndex

指定要检索的客户端的索引。 对于第一次调用 MsiEnumClients 函数，此参数应为零，然后针对后续调用递增。 由于客户端未排序，因此任何新客户端都有任意索引。 这意味着该函数可以按任意顺序返回客户端。

[out] lpProductBuf

指向接收产品代码的缓冲区的指针。 此缓冲区的长度必须为 39 个字符。 前 38 个字符用于 GUID，最后一个字符用于终止 null 字符。

返回值

值 含义
ERROR_BAD_CONFIGURATION
 配置数据已损坏。
ERROR_INVALID_PARAMETER
 向该函数传递了无效参数。
ERROR_NO_MORE_ITEMS
 没有要返回的客户端。
ERROR_NOT_ENOUGH_MEMORY
 系统没有足够的内存来完成操作。 适用于 Windows Server 2003。
ERROR_SUCCESS
 枚举了一个值。
ERROR_UNKNOWN_COMPONENT
 指定的组件未知。

注解

若要枚举客户端，应用程序最初应调用 MsiEnumClients 函数，并将 iProductIndex 参数设置为零。 然后，应用程序应递增 iProductIndex 参数并调用 MsiEnumClients ，直到没有更多客户端 (，直到函数返回ERROR_NO_MORE_ITEMS) 。

对 MsiEnumClients 进行多次调用以枚举组件的所有客户端时，每个调用都应从同一线程进行。

注意

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

要求

   
最低受支持的客户端 Windows Server 2012、Windows 8、Windows Server 2008 R2 或 Windows 7 上的 Windows Installer 5.0。 Windows Server 2008 或 Windows Vista 上的 Windows Installer 4.0 或 Windows Installer 4.5。 Windows Server 2003 或 Windows XP 上的 Windows Installer。 若要了解 Windows Installer 版本所需的最低 Windows Service Pack，请参阅 Windows Installer 运行时要求。
目标平台 Windows
标头 msi.h
Library Msi.lib
DLL Msi.dll

另请参阅

系统状态函数