Qbs Manual

Qbs 1.14.0

# wix

Provides Windows Installer XML Toolset support. More...

Since: | Qbs 1.2

- List of all members, including inherited members

## Properties

- compilerFlags : stringList
- compilerName : string
- compilerPath : string
- cultures : stringList
- debugInformation : bool
- defines : stringList
- enableQbsDefines : bool
- extensions : stringList
- includePaths : pathList
- linkerFlags : stringList
- linkerName : string
- linkerPath : string
- toolchainInstallPath : path
- toolchainInstallRoot : path
- treatWarningsAsErrors : bool
- verboseOutput : bool
- version : string
- versionBuild : int
- versionMajor : int
- versionMinor : int
- versionParts : list
- versionPatch : int
- visualStudioCompatibility : bool
- warningLevel : string

## Detailed Description

The `wix` module contains properties and rules for building MSI and EXE setup packages with the Windows Installer XML Toolset.

This module is available on all platforms.

### Relevant File Tags

Tag | Auto-tagged File Names | Since | Description
--- | --- | --- | ---
`"msi"` | - | 1.2 | The rule that creates the Microsoft Installer setup file attaches this tag to its output artifact.
`"wixpdb"` | - | 1.2 | The rule that creates the Microsoft Installer setup file or WiX setup executable attaches this tag to the associated debug symbol file.
`"wixsetup"` | - | 1.2 | The rule that creates the WiX setup executable attaches this tag to its output artifact.
`"wxi"` | `*.wxi` | 1.2 | This tag is attached to WiX include files.
`"wxl"` | `*.wxl` | 1.2 | This tag is attached to WiX localization files.
`"wxs"` | `*.wxs` | 1.2 | This tag is attached to WiX source files. Each source file will be compiled into one WiX object file.

## Property Documentation

compilerFlags : stringList

A list of additional flags for the Candle compiler.

Default: Undefined

compilerName : string

The name of the compiler binary.

This property should not normally need to be changed.

Default: `"candle.exe"`

compilerPath : string

The directory where the compiler binary is located.

This property should not normally need to be changed.

Default: compilerName

cultures : stringList

A list of localizations to include in the MSI.

If left undefined, includes all localizations.

Default: Undefined

debugInformation : bool

Whether to generate debug information.

Default: qbs.debugInformation

See also qbs.debugInformation.

defines : stringList

A list of preprocessor macros that get passed to the compiler.

To set macro values, use the following syntax:

      wix.defines: ["USE_COLORS=1", 'COLOR_STR="blanched almond"']

Default: Undefined

enableQbsDefines : bool

Whether to define preprocessor macros corresponding to values from the project and product objects.

When building a 64-bit package, the preprocessor variable `Win64` will also be defined.

Default: `true`

extensions : stringList

A list of extension assemblies to link into the output.

Possible values include:

- custom assemblies
- `"WixBalExtension"`
- `"WixComPlusExtension"`
- `"WixDependencyExtension"`
- `"WixDifxAppExtension"`
- `"WixDirectXExtension"`
- `"WixFirewallExtension"`
- `"WixGamingExtension"`
- `"WixIisExtension"`
- `"WixMsmqExtension"`
- `"WixNetFxExtension"`
- `"WixPSExtension"`
- `"WixSqlExtension"`
- `"WixTagExtension"`
- `"WixUIExtension"`
- `"WixUtilExtension"`
- `"WixVSExtension"`

Default: `["WixBalExtension"]` if the product type is an EXE setup application, otherwise `undefined`.

includePaths : pathList

A list of include paths.

Relative paths are considered to be relative to the `.qbs` product file they are used in.

Default: Undefined

linkerFlags : stringList

A list of additional flags for the Light linker.

Default: Undefined

linkerName : string

The name of the linker binary.

This property should not normally need to be changed.

Default: `"light.exe"`

linkerPath : string

The directory where the linker binary is located.

This property should not normally need to be changed.

Default: linkerName

toolchainInstallPath : path

The WiX installation directory.

This property should not normally need to be changed.

Default: Determined automatically by searching the registry for the latest version.

toolchainInstallRoot : path

The WiX binaries directory.

This property should not normally need to be changed.

Default: Determined automatically by searching the registry for the latest version.

treatWarningsAsErrors : bool

Whether warnings will be handled as errors and cause the build to fail.

Default: `false`

verboseOutput : bool

Whether to display verbose output from the compiler and linker.

Default: `false`

version : string

The WiX version.

Consists of four numbers separated by dots. For example, "3.7.1224.0".

Default: Undefined

versionBuild : int

The fourth WiX version number component.

Default: `versionParts[3]`

versionMajor : int

The WiX major version.

Default: `versionParts[0]`

versionMinor : int

The WiX minor version.

Default: `versionParts[1]`

versionParts : list

The WiX version as a list.

For example, WiX version 3.7.1224.0 would correspond to a value of `[3, 7, 1224, 0]`.

Default: `[]`

versionPatch : int

The WiX patch level.

Default: `versionParts[2]`

visualStudioCompatibility : bool

Whether to pass most of the same preprocessor macros to the compiler as Visual Studio does.

This allows easier authoring of WiX files that are compatible with both Qbs and MSBuild.

Default: `true`

warningLevel : string

The severity of warnings to emit.

The higher the level, the more warnings will be shown.

Possible values include: `"none"`, `"normal"`, `"pedantic"`

Default: `"normal"`