Skip to main content
Version: v4.0

MSBuild

info

TODO: WiX v4 documentation is under development.

tip

See Signing packages and bundles for information about signing packages and bundles when using MSBuild.

Properties

You can set the following properties in your .wixproj to control the build:

PropertyDescription
AdditionalCubSemicolon-delimited list of .cub files to use during MSI validation. Default: darice.cub for .msi packages; mergemod.cub for .msm packages
BindFilesWhen true, bind referenced files into the output file. Valid only when building .wixlib WiX libraries. Default: false
CabinetCreationThreadCountSpecifies the number of simultaneous threads used when building multiple cabinets. Default: The number of logical processors in the system.
CompilerAdditionalOptionsA string specifying arbitrary Wix.exe command-line arguments to use during the build. Default: none
DebugTypeSpecifies the .wixpdb output: full for full symbol information or none to suppress the .wixpdb. Default: full
DefaultCompressionLevelSpecifies the compression level used when none is specified via MediaTemplate or Media. Valid values are: none, low, medium, high, mszip. Default: medium. Default Wix.exe switch: -defaultcompressionlevel
DefineConstantsSemicolon-delimited list of name=value string pairs that specify preprocessor variable values. Default: none
IcesSemicolon-delimited list of ICE validation names to run during MSI validation. Default: all available ICEs
IncludeSearchPathsSemicolon-delimited list of paths to use to locate <?include?> files. Default: current directory
InstallerPlatformArchitecture of the package or bundle. Valid values are: x86, x64, arm64. Default: $(Platform). Default Wix.exe switch: -arch
IntermediateOutputPathPath used for intermediate outputs. Default: obj/platform/configuration
LinkerAdditionalOptionsA string specifying arbitrary Wix.exe command-line arguments to use during the build. Default: none
OutputTypeSpecifies the type of package being built. Valid values are: Package, Module, Patch, PatchCreation, Library, Bundle, IntermediatePostLink. Default: Package
PedanticIf true, turns on pedantic warning messages. Default: false
SuppressAllWarningsIf true, turns off all warning messages. Default: false
SuppressIcesSemicolon-delimited list of ICE validation names to not run during MSI validation. Default: none
SuppressSpecificWarningsSemicolon-delimited list of warning message numbers to turn off. Default: none
SuppressValidationIf true, turns off MSI validation. Default: false
TreatSpecificWarningsAsErrorsSemicolon-delimited list of warning message numbers to treat as errors. Default: none
TreatWarningsAsErrorsIf true, treats all warning messages as errors. Default: false
ValidationAdditionalOptionsA string specifying arbitrary Wix.exe command-line arguments to use during validation. Default: none
VerboseOutputIf true, turns on verbose messages. Default: false

Items

ItemDescription
BindPathBind paths used to locate payload files. To create named bind paths, specify BindName metadata with the name of the bind path.
CompileFiles to compile. By default, the WiX SDK automatically includes all WiX authoring using the wildcard **/*.wxs. To control default items, see the project SDK documentation.
EmbeddedResourceLocalization files used to build locale-specific packages. By default, the WiX SDK automatically includes all localization files using the wildcard **/*.wxl. To control default items, see the project SDK documentation.
WixLibraryPaths to WiX libraries (.wixlib files) that contain authoring referenced by the package being built.