MsiSummaryInfoSetPropertyA function (msiquery.h)

Article
02/09/2023

The MsiSummaryInfoSetProperty function sets a single summary information property.

Note The meaning of the property value depends on whether the summary information stream is for an installation database (.msi file), transform (.mst file) or patch (.msp file). See Summary Property Descriptions and Summary Information Stream Property Set for more information about summary information properties.

Syntax

UINT MsiSummaryInfoSetPropertyA(
  [in] MSIHANDLE hSummaryInfo,
  [in] UINT      uiProperty,
  [in] UINT      uiDataType,
  [in] INT       iValue,
  [in] FILETIME  *pftValue,
  [in] LPCSTR    szValue
);

Parameters

[in] hSummaryInfo

Handle to summary information.

[in] uiProperty

Specifies the property ID of the summary property being set. This parameter can be a property ID listed in the Summary Information Stream Property Set. This function does not set values for PID_DICTIONARY OR PID_THUMBNAIL property.

[in] uiDataType

Specifies the type of property to set. This parameter can be a type listed in the Summary Information Stream Property Set.

[in] iValue

Specifies the integer value.

[in] pftValue

Specifies the file-time value.

[in] szValue

Specifies the text value.

Return value

The MsiSummaryInfoSetProperty function returns the following values:

Remarks

Note

The msiquery.h header defines MsiSummaryInfoSetProperty as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows Installer 5.0 on Windows Server 2012, Windows 8, Windows Server 2008 R2 or Windows 7. Windows Installer 4.0 or Windows Installer 4.5 on Windows Server 2008 or Windows Vista. Windows Installer on Windows Server 2003 or Windows XP
Target Platform	Windows
Header	msiquery.h
Library	Msi.lib
DLL	Msi.dll