MsiGetSourcePathA 函数 (msiquery.h)

MsiGetSourcePath 函数返回 Directory 表中文件夹的完整源路径。

语法

UINT MsiGetSourcePathA(
  [in]      MSIHANDLE hInstall,
  [in]      LPCSTR    szFolder,
  [out]     LPSTR     szPathBuf,
  [in, out] LPDWORD   pcchPathBuf
);

参数

[in] hInstall

对提供给 DLL 自定义操作的安装句柄,或通过 MsiOpenPackageMsiOpenPackageExMsiOpenProduct获取的安装句柄。

[in] szFolder

一个以 null 结尾的字符串,指定 Directory 表的记录。 如果目录是根目录,则此值可以是 DefaultDir 列中的值。 否则,它必须是目录列中的值。

[out] szPathBuf

指向接收 null 终止的完整源路径的缓冲区的指针。 请勿尝试通过传入 szPathBuf的 null(value=0)来确定缓冲区的大小。 可以通过传入空字符串来获取缓冲区的大小(例如“)。 然后,该函数返回ERROR_MORE_DATA,pcchPathBuf 包含 TCHAR 中所需的缓冲区大小,不包括终止 null 字符。 返回ERROR_SUCCESS时,pcchPathBuf 包含写入缓冲区的 TCHAR 数,不包括终止 null 字符。

[in, out] pcchPathBuf

指向指定变量 szPathBuf指向的缓冲区的大小(以 TCHAR 为单位)的变量的指针。 函数返回ERROR_SUCCESS时,此变量包含复制到 szPathBuf的数据的大小,不包括终止 null 字符。 如果 szPathBuf 不够大,则该函数将返回ERROR_MORE_DATA并存储所需的大小(不包括终止 null 字符)pcchPathBuf指向的变量中。

返回值

MsiGetSourcePath 函数返回以下值:

言论

在调用此函数之前,安装程序必须先运行 CostInitialize 操作FileCost 操作CostFinalize 操作。 有关详细信息,请参阅 从程序调用数据库函数。

如果返回ERROR_MORE_DATA,则为指针的参数提供保存字符串所需的缓冲区大小。 如果返回ERROR_SUCCESS,则它提供写入字符串缓冲区的字符数。 因此,可以通过传入指定缓冲区的参数的空字符串(例如“”)来获取缓冲区的大小。 不要尝试通过传入 Null(value=0)来确定缓冲区的大小。

如果函数失败,可以使用 MsiGetLastErrorRecord获取扩展错误信息。

注意

msiquery.h 标头将 MsiGetSourcePath 定义为一个别名,该别名根据 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
目标平台 窗户
标头 msiquery.h
Msi.lib
DLL Msi.dll

另请参阅

安装程序位置函数

将 Null 作为 Windows Installer 函数的参数传递