msi.h) (MsiGetProductPropertyA 函数

MsiGetProductProperty 函数检索产品属性。 这些属性位于产品数据库中。

语法

UINT MsiGetProductPropertyA(
  [in]      MSIHANDLE hProduct,
  [in]      LPCSTR    szProperty,
  [out]     LPSTR     lpValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

参数

[in] hProduct

MsiOpenProduct 获取的产品的句柄。

[in] szProperty

指定要检索的属性。 此参数区分大小写。

[out] lpValueBuf

指向接收属性值的缓冲区的指针。 如果 lpValueBuf 太小,该值将被截断并以 null 结尾。 此参数可以为 null。

[in, out] pcchValueBuf

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

如果 lpValueBuf 为 null, 则 pcchValueBuf 可以为 null。

返回值

MsiGetProductProperty 函数返回以下值。

含义
ERROR_INVALID_PARAMETER
向该函数传递了无效参数。
ERROR_INVALID_HANDLE
传递给函数的句柄无效。
ERROR_MORE_DATA
缓冲区太小,无法容纳整个属性值。
ERROR_SUCCESS
函数已成功完成。
 
 

注解

MsiGetProductProperty 函数返回时, pcchValueBuf 参数包含存储在缓冲区中的字符串的长度。 返回的计数不包括终止 null 字符。 如果缓冲区不够大, MsiGetProductProperty 将返回ERROR_MORE_DATA, 并且 MsiGetProductProperty 包含字符串的大小(以字符为单位),而不计算 null 字符。

注意

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

另请参阅

产品查询函数