WiX Toolset

Restrictions for Patches

There are different restrictions for patches based on what type of patch is to be installed. There are three types of patches:

  • Small updates do not change the ProductVersion property of a target product and typically represent a small subset of files to be updated.
  • Minor upgrades do change the ProductVersion property of a target product and typically represent a larger subset of files to be updated. Minor upgrades might also be installed as upgrade MSIs.
  • Major upgrades change both the ProductVersion and ProductCode and contain all files in a product. Shipping major upgrades as a patch is, however, not recommended and WiX does not support building major upgrade patches because of the problems they create.

For information about restrictions for each type of patch, read Changing the Product Code.

Uninstallable Patches

For a patch to be uninstallable, the MsiPatchMetadata table must exist in the patch package and must contain the AllowRemoval property set to 1. This can be authored into the Patch Creation Properties file using the PatchMetadata/@AllowRemoval attribute or into the patch XML file using the Patch/@AllowRemoval attribute.

Beside that, certain tables cannot be modified in the upgrade package from which a patch is built. Read Uninstallable Patches for the current list of tables. Pyro.exe will error if one of these tables would be modified when building a patch XML file.

The following table lists tables and corresponding elements or attributes in WiX.

Table

Element or Attribute

BindImage

[File](../xsd/wix/file.html)/@BindPath

Class

[Class](../xsd/wix/class.html)

Complus

[Component](../xsd/wix/component.html)/@ComPlusFlags

CreateFolder

[CreateFolder](../xsd/wix/createfolder.html)

DuplicateFile

[CopyFile](../xsd/wix/copyfile.html)

Environment

[Environment](../xsd/wix/environment.html)

Extension

[Extension](../xsd/wix/extension.html)

Font

[File](../xsd/wix/file.html)/@FontTitle

IniFile

[IniFile](../xsd/wix/inifile.html)

IsolatedComponent

[IsolatedComponent](../xsd/wix/isolatecomponent.html)

LockPermissions

[Permission](../xsd/wix/permission.html)

MIME

[MIME](../xsd/wix/mime.html)

MoveFile

[CopyFile](../xsd/wix/copyfile.html)

ODBCAttribute

[ODBCDriver](../xsd/wix/odbcdriver.html)/[Property](../xsd/wix/property.html)

ODBCDataSource

[ODBCDataSource](../xsd/wix/odbcdatasource.html)

ODBCDriver

[ODBCDriver](../xsd/wix/odbcdriver.html)

ODBCSourceAttribute

[ODBCDataSource](../xsd/wix/odbcdatasource.html)/[Property](../xsd/wix/property.html)

ODBCTranslator

[ODBCTranslator](../xsd/wix/odbctranslator.html)

ProgId

[ProgId](../xsd/wix/progid.html)

PublishComponent

[Category](../xsd/wix/category.html)

RemoveIniFile

[IniFile](../xsd/wix/inifile.html)

SelfReg

[File](../xsd/wix/file.html)/@SelfRegCost

ServiceControl

[ServiceControl](../xsd/wix/servicecontrol.html)

ServiceInstall

[ServiceInstall](../xsd/wix/serviceinstall.html)

TypeLib

[TypeLib](../xsd/wix/typelib.html)

Verb

[Verb](../xsd/wix/verb.html)

Major upgrade patches are not uninstallable.