Upgrade attributes (MSI)

Reference information
Project page Upgrade Information (MSI)
Related topics Working with attribute panes
External links External link Windows Installer documentation

Introduction

An Upgrade object describes a previous product version that must be upgraded when the current product is installed.

Tarma note Tarma Installer handles upgrades with the Uninstall Product action.

Attributes

This pane contains the following attributes and options.

Attribute Description
Upgrade code

Enter the GUID of the upgrade family to which the product that must be upgraded belongs. Only products that are installed with this GUID as their Upgrade Code (see Installer Options) are considered for the upgrade.

Min version

Enter the minimum product version that must be upgraded, or leave empty if all versions up to the maximum must be upgraded. The version number must be in the format a.b.c with each letter a decimal number from 0 to 65535.

Note: You must specify at least one of Min version and Max version.

Inclusive

Check this box to include the Min version number in the version range; clear it to exclude it from the range. For example, if Min version is set to 2.0, then checking this box includes all versions >= 2.0; clearing it includes all versions > 2.0 (i.e., strictly greater than).

Max version

Enter the maximum product version that must be upgraded, or leave empty if all versions beyond the minimum must be upgraded. The version number must be in the format a.b.c with each letter a decimal number from 0 to 65535.

Note: You must specify at least one of Min version and Max version.

Inclusive

Check this box to include the Max version number in the version range; clear it to exclude it from the range. For example, if Max version is set to 3.0, then checking this box includes all versions <= 3.0; clearing it includes all versions < 3.0 (i.e., strictly less than).

Languages Enter the languages (in decimal format) of the products that must be upgraded, or leave empty if all product languages must be upgraded.
Exclusive

Check this box to interpret the Languages field as "all languages except those specified"; clear it to mean "all specified languages". If the Languages field is empty, this option is ignored.

Remove Enter a list of comma-separated feature names that must be removed during the upgrade, or leave blank to remove all features of prior products during the upgrade.
Property

Enter the name of the property (product variable) that will receive the list of product codes that are detected during the upgrade check. This must be a public property, i.e., its name may not contain lowercase characters. Furthermore, the name of this property must be added to the SecureCustomProperties property.

Tip: The default RELATEDPRODUCTS property is already set in SecureCustomProperties.

Migrate features Check this box to migrate any pre-existing feature states to the new product; clear it to ignore the existing feature states.
Only detect

Check this box to detect any pre-existing products (and set the Property property accordingly) without removing them; clear this box to remove the existing products.

Ignore failures Check this box to continue the installation even if the removal of pre-existing products fails; clear it to fail the installation if existing product removal fails.