MsiGetComponentPathExA 函数 (msi.h)

  • 项目

MsiGetComponentPathEx 函数返回已安装组件的完整路径。 如果组件的键路径是注册表项，则该函数返回注册表项。

此函数扩展现有的 MsiGetComponentPath 函数，以允许跨用户帐户和安装上下文搜索组件。

语法

INSTALLSTATE MsiGetComponentPathExA(
  [in]                LPCSTR            szProductCode,
  [in]                LPCSTR            szComponentCode,
  [in, optional]      LPCSTR            szUserSid,
  [in, optional]      MSIINSTALLCONTEXT dwContext,
  [out, optional]     LPSTR             lpOutPathBuffer,
  [in, out, optional] LPDWORD           pcchOutPathBuffer
);

参数

[in] szProductCode

一个以 null 结尾的字符串值，该值指定应用程序的产品代码 GUID。 函数获取此应用程序使用的已安装组件的路径。

[in] szComponentCode

一个以 null 结尾的字符串值，该值指定组件代码 GUID。 函数获取具有此组件代码的已安装组件的路径。

[in, optional] szUserSid

一个以 null 结尾的字符串值，该值指定系统中用户的安全标识符 (SID) 。 函数获取在此 SID 标识的用户帐户下安装的应用程序的已安装组件的路径。 特殊 SID 字符串 s-1-1-0 (Everyone) 指定系统中的所有用户。 如果此参数为 NULL，则该函数仅获取当前登录用户的已安装组件的路径。

SID 类型 含义
NULL
 指定当前登录的用户。
用户 SID
 指定系统中的特定用户。 用户 SID 的示例为“S-1-3-64-2415071341-1358098788-3127455600-2561”。
s-1-1-0
 指定系统中的所有用户。
 
注意 特殊 SID 字符串 s-1-5-18 (系统) 不能用于搜索在每台计算机安装上下文中安装的应用程序。 将 SID 值设置为 s-1-5-18 将返回 ERROR_INVALID_PARAMETER。 如果 dwContext 设置为仅MSIINSTALLCONTEXT_MACHINE， 则 szUserSid 必须为 NULL。
 

[in, optional] dwContext

一个指定安装上下文的标志。 函数获取在指定安装上下文中安装的应用程序的已安装组件的路径。 此参数可以是以下值的组合。

上下文 含义
MSIINSTALLCONTEXT_USERMANAGED
1
 包括每用户托管安装上下文中安装的应用程序。
MSIINSTALLCONTEXT_USERUNMANAGED
2
 包括每用户-非托管安装上下文中安装的应用程序。
MSIINSTALLCONTEXT_MACHINE
4
 包括每台计算机安装上下文中安装的应用程序。 如果 dwInstallContext 设置为仅 MSIINSTALLCONTEXT_MACHINE ， 则 szUserSID 参数必须为 NULL。

[out, optional] lpOutPathBuffer

接收组件路径的字符串值。 此参数可以为 NULL。 如果组件是一个注册表项，则注册表根目录以数字表示。 如果这是注册表子项路径，则密钥路径的末尾有一个反斜杠。 如果这是注册表项路径，则末尾没有反斜杠。 例如， HKEY_CURRENT_USER\SOFTWARE\Microsoft 的 32 位操作系统上的注册表路径返回为“01：\SOFTWARE\Microsoft”。 在 32 位操作系统上返回的注册表根定义如下表所示。

注意 在 64 位操作系统上，值 20 将添加到此表中的数值注册表根，以将它们与 32 位操作系统上的注册表项路径区分开来。 例如，如果组件路径是 64 位操作系统上的注册表项， 则 HKEY_CURRENT_USER\SOFTWARE\Microsoft 的注册表项路径将返回为“21：\SOFTWARE\Microsoft\”。
 
Root 含义
HKEY_CLASSES_ROOT
 00
HKEY_CURRENT_USER
 01
HKEY_LOCAL_MACHINE
02
HKEY_USERS
 03

[in, out, optional] pcchOutPathBuffer

指向接收 SzPathBuf 参数所指向的缓冲区大小的指针（在 TCHAR 中）。 此位置的值应设置为字符串中的 TCHAR 计数，包括终止 null 字符。 如果缓冲区的大小太小，则此参数接收字符串值的长度，而不在计数中包含终止 null 字符。

返回值

MsiGetComponentPathEx 函数返回以下值。

值 含义
INSTALLSTATE_NOTUSED
 正在请求的组件在计算机上处于禁用状态。
INSTALLSTATE_BADCONFIG
 配置数据已损坏。
INSTALLSTATE_ABSENT
 组件未安装。
INSTALLSTATE_INVALIDARG
 其中一个函数参数无效。
INSTALLSTATE_LOCAL
 组件在本地安装。
INSTALLSTATE_SOURCE
 安装组件以从源运行。
INSTALLSTATE_SOURCEABSENT
 组件源不可访问。
INSTALLSTATE_UNKNOWN
 产品代码或组件 ID 未知。
INSTALLSTATE_BROKEN
 组件以某种方式损坏或部分缺失，需要修复。

注解

MsiGetComponentPathEx 函数可能会返回INSTALLSTATE_ABSENT或INSTALL_STATE_UNKNOWN，原因如下：

  • INSTALLSTATE_ABSENT

    应用程序未正确确保通过调用 MsiUseFeature 和 MsiConfigureFeature（如有必要）来安装该功能。

  • INSTALLSTATE_UNKNOWN

    此功能未发布。 应用程序之前应该通过调用 MsiQueryFeatureState 或 MsiEnumFeatures 来确定这一点。 应用程序在初始化时进行这些调用。 应用程序应仅使用已知要发布的功能。 由于 msiUseFeature 也应返回INSTALLSTATE_UNKNOWN，因此未调用 MsiUseFeature ，或者未正确检查其返回值。

注意

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

要求

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

另请参阅

特定于组件的函数