MsiSummaryInfoSetProperty function

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 MsiSummaryInfoSetProperty(
  _In_  MSIHANDLE hSummaryInfo,
  _In_  UINT uiProperty,
  _In_  UINT uiDataType,
  _In_  INT iValue,
  _In_  FILETIME *pftValue,
  _In_  LPTSTR szValue
);

Parameters

hSummaryInfo [in]

Handle to summary information.

uiProperty [in]

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.

uiDataType [in]

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

iValue [in]

Specifies the integer value.

pftValue [in]

Specifies the file-time value.

szValue [in]

Specifies the text value.

Return value

The MsiSummaryInfoSetProperty function returns the following values:

ERROR_DATATYPE_MISMATCH

The data types were mismatched.

ERROR_FUNCTION_FAILED

The function failed.

ERROR_INVALID_HANDLE

An invalid or inactive handle was supplied.

ERROR_INVALID_PARAMETER

An invalid parameter was passed to the function.

ERROR_SUCCESS

The function succeeded.

ERROR_UNKNOWN_PROPERTY

The summary information property is unknown.

ERROR_UNSUPPORTED_TYPE

The type is unsupported.

Requirements

Version

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

Header

Msiquery.h

Library

Msi.lib

DLL

Msi.dll

Unicode and ANSI names

MsiSummaryInfoSetPropertyW (Unicode) and MsiSummaryInfoSetPropertyA (ANSI)

See also

Summary Information Property Functions
Summary Information Stream Property Set
Summaryinfo.Property

 

 

Community Additions

ADD
Show:
© 2014 Microsoft