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 (每个人)指定系统中的所有用户。 如果此参数 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\”。
 
意义
HKEY_CLASSES_ROOT
00
HKEY_CURRENT_USER
01
HKEY_LOCAL_MACHINE
02
HKEY_USERS
03

[in, out, optional] pcchOutPathBuffer

指向 TCHAR中接收缓冲区大小的位置的指针,该位置由 szPathBuf 参数指向。 此位置中的值应设置为字符串中的 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_ABSENTINSTALL_STATE_UNKNOWN,原因如下:

  • INSTALLSTATE_ABSENT

    应用程序未正确确保通过调用 MsiUseFeature 安装该功能,并在必要时 MsiConfigureFeature

  • INSTALLSTATE_UNKNOWN

    此功能未发布。 应用程序应早先通过调用 MsiQueryFeatureStateMsiEnumFeatures来确定此情况。 应用程序在初始化时进行这些调用。 应用程序应仅使用已知已发布的功能。 由于INSTALLSTATE_UNKNOWN应该也由 MsiUseFeature 返回,因此未调用 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 Run-Time 要求。
目标平台 窗户
标头 msi.h
Msi.lib
DLL Msi.dll

另请参阅

Component-Specific Functions