msisummaryInfoGetPropertyW 函数 (msiquery.h)

  • 项目

MsiSummaryInfoGetProperty 函数从摘要信息流中获取单个属性。

注意 属性值的含义取决于摘要信息流是用于安装数据库 (.msi 文件) 、转换 (.mst 文件) 还是修补 (.msp 文件) 。 有关摘要信息属性的详细信息，请参阅 Summary Property Descriptions 和 Summary Information Stream Property Set。
 

语法

UINT MsiSummaryInfoGetPropertyW(
  [in]      MSIHANDLE hSummaryInfo,
  [in]      UINT      uiProperty,
  [out]     PUINT     puiDataType,
  [out]     LPINT     piValue,
  [out]     FILETIME  *pftValue,
  [out]     LPWSTR    szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

参数

[in] hSummaryInfo

摘要信息的句柄。

[in] uiProperty

指定摘要属性的属性 ID。 此参数可以是“摘要信息Stream属性集”中列出的属性 ID。 此函数不返回 PID_DICTIONARY OR PID_THUMBNAIL 属性的值。

[out] puiDataType

接收返回的属性类型。 此参数可以是 中列出的类型
属性集Stream摘要信息。

[out] piValue

接收返回的整数属性数据。

[out] pftValue

指向文件值的指针。

[out] szValueBuf

指向接收 null 终止摘要信息属性值的缓冲区的指针。 请勿尝试通过为 szValueBuf 传入 null (value=0) 来确定缓冲区的大小。 可以通过传入空字符串 (（例如“”) ）来获取缓冲区的大小。 然后，该函数返回ERROR_MORE_DATA pcchValueBuf 在 TCHAR 中包含所需的缓冲区大小，不包括终止 null 字符。 返回ERROR_SUCCESS时， pcchValueBuf 包含写入缓冲区的 TCHAR 数，不包括终止 null 字符。 如果没有错误，此参数为空字符串。

[in, out] pcchValueBuf

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

返回值

MsiSummaryInfoGetProperty 函数返回以下值之一：

注解

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

不应使用 null 作为指针的值调用在用户提供的内存位置返回数据的 Windows Installer 函数。 这些函数以整数指针的形式返回字符串或返回数据，但在将 null 作为输出参数的值传递时会返回不一致的值。 有关详细信息，请参阅 传递 Null 作为 Windows Installer 函数的参数。

piValue、pftValue 或 szValueBuf 参数接收 MsiSummaryInfoGetProperty 函数返回的属性信息，具体取决于 puiDataType 参数中指定的属性值的类型。

注意

msiquery.h 标头将 MsiSummaryInfoGetProperty 定义为别名，该别名根据 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
标头 msiquery.h
Library Msi.lib
DLL Msi.dll

另请参阅

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

摘要信息属性函数

摘要信息流属性集

Summaryinfo.Property