Run Wix Custom action only during uninstall and not during Major upgrade

by

Phil has already answered. I’ll just post what I wrote a few hours ago
before heading out. The conditions you specify look pretty good to me.
Maybe I’ll do a quick review of things that are likely to cause
confusion – such as what custom actions run when?

Major Upgrades: A major upgrade is really an install of a new application version combined with the uninstall of the old version – with different uninstall scheduling possible (uninstall old and install new, or install new and uninstall old). Hence, during a major upgrade operation, 1) the uninstall sequence runs only for the old setup, and 2) the new setup runs only its install sequence. This is of crucial importance to understand what custom actions runs when and why.

Custom Actions and Major Upgrades: To put it in other words: this sequencing can cause quite a bit of confusion for custom action sequencing, since it could appear that an action runs from the new setup, when it in fact runs in the old setup’s uninstall sequence. If you are sloppy with sequencing, the typical error is seeing the same action run many times during the upgrade process – potentially twice from each setup (four times in total) – if you run the custom action in immediate mode.

No Retrofitting for Major Upgrades: As Phil explains, you can not add a custom action that will run during the old setup’s uninstall sequence inside the new setup. That custom action would have had to be part of the original setup, or added via a minor upgrade (which upgrades the existing installation in-place, rather than uninstall and reinstall it).

Important:

  • UPGRADINGPRODUCTCODE is set only in a setup that is being uninstalled as part of a major upgrade. It is not set in the new
    version being installed.

    • The condition UPGRADINGPRODUCTCODE is hence not true in the installing setup, only in the uninstalling setup.
  • WIX_UPGRADE_DETECTED is set only in setups that are using WiX’s MajorUpgrade element that have detected that another version is
    being uninstalled as part of its install.

    • The condition WIX_UPGRADE_DETECTED is hence true in the installing setup, but not in the uninstalling setup.

WIX_UPGRADE_DETECTED: To go into even more detail, WIX_UPGRADE_DETECTED is strictly speaking not a custom WiX feature – it is a WiX standard or convention for setting the built-in MSI property ActionProperty for the upgrade process. All MSI files supporting major upgrades have such a property, WiX just names it in a standard way. The property is set in a column in the Upgrade table, and it is a property that is set when a setup finds related products – that are lower versions (and hence to be uninstalled) – on the same box during installation.

WIX_DOWNGRADE_DETECTED: Note that in a standard WiX-compiled MSI using the MajorUpgrade element there is also WIX_DOWNGRADE_DETECTED – the property used to list products found that are of higher version than the running setup. These would block the setup in question from installing – in most cases (unless the settings are customized by the setup designer).

The action property specified in the upgrade table can be “anything”, but the MajorUpgrade Element “convenience feature” does this for you in an “auto-magical” way that makes sense for most purposes – using the mentioned property names WIX_UPGRADE_DETECTED and WIX_DOWNGRADE_DETECTED. Check the Upgrade Table of your compiled MSI to see how this works in detail. Here is a screen shot:

Upgrade Table of compiled WiX MSI

I wrote this other answer showing how to use another property name (YOURUPGRADEPROPERTY) as “ActionProperty“: wix installer update process and confirmation dialog (the linked answer is not a recommendation, demonstration only). Just a link, probably not very useful for you now that I think about it.

Some Links:

More Related Contents:

  1. Adding entries to MSI UpgradeTable to remove related products
  2. Reboot on install, Don’t reboot on uninstall
  3. Doing Major Upgrade in Wix creates 2 entries in Add/Remove Programs
  4. WIX (remove all previous versions)
  5. Change my component GUID in wix?
  6. Changing text color to Wix dialogs
  7. WIX does not uninstall older version
  8. What do I do when launching an application triggers repeating, endless Windows Installer self-repair?
  9. How do I avoid triggering MSI self-repair with my WiX / MSI package?
  10. Uninstall from Control Panel is different from Remove from .msi
  11. Microsoft Installer command line string parameter not working?
  12. wix – custom action dialogbox on silent uninstall of application
  13. Interrupt installation when custom action returns error
  14. How to Explicitly Remove dll During Majorupgrade Using Wix Toolset
  15. File of a new component isn’t installed because there was an old component with the same file
  16. I screwed up, how can I uninstall my program?
  17. WIX merge c++ runtime
  18. In WiX files, what does Name=”SourceDir” refer to?
  19. Why is it a good idea to limit deployment of files to the user-profile or HKCU when using MSI?
  20. Wix Custom Action – session empty and error on deferred action
  21. One file per component or several files per component?
  22. Unselected Feature Being Installed
  23. How do I avoid distributing sensitive information in my MSI by accident?
  24. Wix burn doesn’t allow to remove file
  25. Wix Tools update uses old custom actions
  26. VersionNT MSI property on Windows 10
  27. how to find out which products are installed – newer product are already installed MSI windows
  28. How to assign path value to Directory in WIX?
  29. Failed to get MSI property in UPGRADINGPRODUCTCODE, WIX_UPGRADE_DETECTED
  30. Wix per user installer to detect the Visual C++ 2015 Redistributable

Leave a Comment