RemoveFile Element

WiX Help

RemoveFile Element

Description

Remove a file(s) if the parent component is selected for installation or removal. Multiple files can be removed by specifying a wildcard for the value of the Name attribute. By default, the source directory of the file is the directory of the parent component. This can be overridden by specifying the Directory attribute with a value corresponding to the Id of the source directory, or by specifying the Property attribute with a value corresponding to a property that will have a value that resolves to the full path to the source directory.

Windows Installer references
RemoveFile Table
Parents
Component, Include
Inner Text
None
Children
None
Attributes
Name Type Description Required
Id String Primary key used to identify this particular entry. Yes
Directory String Overrides the directory of the parent component with a specific Directory. This Directory must exist in the installer database at creation time. This attribute cannot be specified in conjunction with the Property attribute.  
LongName WildCardLongFileNameType If the name of the file(s) to be removed need to be longer than 8.3 format, then this attribute should be specified with the long file name (in addition to the Name attribute which is always required for target systems that might not support long file names). All of the files that match the wild card will be removed from the specified directory. The value is a filename that may also contain the wild card characters "?" for any single character or "*" for zero or more occurrences of any character.  
Name WildCardShortFileNameType This value should be set to the localizable name of the file(s) to be removed. All of the files that match the wild card will be removed from the specified directory. The value is a filename that may also contain the wild card characters "?" for any single character or "*" for zero or more occurrences of any character.  
On Enumeration This value determines the time at which the file(s) may be removed. This attribute's value should be one of the following:
install
Removes the file only when the parent component is being installed (msiInstallStateLocal or msiInstallStateSource).
uninstall
Removes the file only when the parent component is being removed (msiInstallStateAbsent).
both
Removes the file when the parent component is being installed or removed.
Yes
Property String Overrides the directory of the parent component with the value of the specified property. The property should have a value that resolves to the full path of the source directory. The property does not have to exist in the installer database at creation time; it could be created at installation time by a custom action, on the command line, etc. This attribute cannot be specified in conjunction with the Directory attribute.  
See Also
Wix Schema, CopyFile