MsiEnumRelatedProductsA 函数 (msi.h)

  • 项目

MsiEnumRelatedProducts 函数枚举具有指定升级代码的产品。 此函数列出当前安装和播发的产品，其属性表中具有指定的 UpgradeCode 属性。

语法

UINT MsiEnumRelatedProductsA(
  [in]  LPCSTR lpUpgradeCode,
  [in]  DWORD  dwReserved,
  [in]  DWORD  iProductIndex,
  [out] LPSTR  lpProductBuf
);

parameters

[in] lpUpgradeCode

以 null 结尾的字符串，指定安装程序要枚举的相关产品的升级代码。

[in] dwReserved

此参数是保留的，必须为 0。

[in] iProductIndex

注册产品的从零开始的索引。

[out] lpProductBuf

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

返回值

值 含义
ERROR_BAD_CONFIGURATION
 配置数据已损坏。
ERROR_INVALID_PARAMETER
 向该函数传递了无效参数。
ERROR_NO_MORE_ITEMS
 没有产品可退回。
ERROR_NOT_ENOUGH_MEMORY
 系统没有足够的内存来完成操作。 从 Windows Server 2003 开始可用。
ERROR_SUCCESS
 枚举了值。

注解

请参阅 UpgradeCode 属性。

若要枚举当前安装和播发具有特定升级代码的产品，应用程序应首先调用将 iProductIndex 参数设置为零的 MsiEnumRelatedProducts 函数。 然后，应用程序应递增 iProductIndex 参数并调用 MsiEnumRelatedProducts ，直到函数返回ERROR_NO_MORE_ITEMS，这意味着没有其他具有指定升级代码的产品。

对 MsiEnumRelatedProducts 进行多次调用以枚举所有相关产品时，每个调用都应从同一线程进行。

注意

msi.h 标头将 MsiEnumRelatedProducts 定义为别名，该别名根据 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