MsiGetComponentPathA 函数 (msi.h)

MsiGetComponentPath 函数返回已安装组件的完整路径。 如果组件的密钥路径是注册表项,则返回注册表项。

语法

INSTALLSTATE MsiGetComponentPathA(
  [in]      LPCSTR  szProduct,
  [in]      LPCSTR  szComponent,
  [out]     LPSTR   lpPathBuf,
  [in, out] LPDWORD pcchBuf
);

参数

[in] szProduct

指定客户端产品的代码示例。

[in] szComponent

指定要定位的组件的组件 ID。

[out] lpPathBuf

指向接收组件路径的变量的指针。 此参数可以为 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] pcchBuf

指向一个变量的指针,该变量指定由 lpPathBuf 参数指向的缓冲区的大小(以字符为单位)。 在输入时,这是缓冲区的完整大小,包括终止 null 字符的空间。 如果传入的缓冲区太小,则返回的计数不包括终止 null 字符。

如果 lpPathBuf 为 null,pcchBuf 可以为 null。

返回值

MsiGetComponentPath 函数返回以下值。

价值 意义
INSTALLSTATE_NOTUSED
正在请求的组件在计算机上处于禁用状态。
INSTALLSTATE_ABSENT
未安装该组件。
INSTALLSTATE_INVALIDARG
其中一个函数参数无效。
INSTALLSTATE_LOCAL
组件在本地安装。
INSTALLSTATE_SOURCE
安装组件以从源运行。
INSTALLSTATE_SOURCEABSENT
组件源不可访问。
INSTALLSTATE_UNKNOWN
产品代码或组件 ID 未知。

言论

MsiGetComponentPath 函数成功后,pcchBuf 参数包含 lpPathBuf中的字符串长度。

MsiGetComponentPath 函数可能会返回INSTALLSTATE_ABSENT或INSTALL_STATE_UNKNOWN,原因如下:

  • INSTALLSTATE_ABSENT

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

  • INSTALLSTATE_UNKNOWN

    此功能未发布。 应用程序应早先通过调用 MsiQueryFeatureStateMsiEnumFeatures来确定此情况。 应用程序在初始化时进行这些调用。 应用程序应仅使用已知已发布的功能。 由于INSTALLSTATE_UNKNOWN应该也由 MsiUseFeature 返回,因此未调用 msiUseFeature ,或者未正确检查其返回值。

注意

msi.h 标头将 MsiGetComponentPath 定义为一个别名,该别名根据 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 Run-Time 要求。
目标平台 窗户
标头 msi.h
Msi.lib
DLL Msi.dll

另请参阅

Component-Specific Functions