Lit Task

WiX

Lit Task

The Lit task wraps lit.exe, the WiX library creation tool. It supports a variety of settings that are described in more detail below. To control these settings in your .wixproj file, you can create a PropertyGroup and specify the settings that you want to use for your build process. The following is a sample PropertyGroup that contains settings that will be used by the Lit task:

<PropertyGroup>
    <LibTreatWarningsAsErrors>False</LibTreatWarningsAsErrors>
    <LibVerboseOutput>True</LibVerboseOutput>
    <SuppressSpecificWarnings>1111</SuppressSpecificWarnings>
    <TreatSpecificWarningsAsErrors>2222</TreatSpecificWarningsAsErrors>
</PropertyGroup>

The following table describes the common WiX MSBuild parameters that are applicable to the Lit task.

Parameter Description
BindInputPaths Optional string parameter.

Specifies a binder path that should be used to locate all files. This is equivalent to the -b <path> switch.
Named BindPaths are created by prefixing the 2-or-more-character bucket name followed by an equal sign ("=") to the supplied path.
BindFiles Optional boolean parameter.

Specifies that the tool should bind files into a .wixout file. This is only valid when the OutputAsXml parameter is also provided. This is equivalent to the -bf switch.
Pedantic Optional boolean parameter.

Specifies that the tool should display pedantic messages. This is equivalent to the -pedantic switch.
SuppressAllWarnings Optional boolean parameter.

Specifies that all warnings should be suppressed. This is equivalent to the -sw switch.
SuppressIntermediateFileVersionMatching Optional boolean parameter.

Specifies that the tool should suppress intermediate file version mismatch checking. This is equivalent to the -sv switch.
SuppressSchemaValidation Optional boolean parameter.

Specifies that schema validation of documents should be suppressed. This is equivalent to the -ss switch.
SuppressSpecificWarnings Optional string parameter.

Specifies that certain warnings should be suppressed. This is equivalent to the -sw[N] switch.
TreatSpecificWarningsAsErrors Optional string parameter.

Specifies that certain warnings should be treated as errors. This is equivalent to the -wx[N] switch.
TreatWarningsAsErrors Optional boolean parameter.

Specifies that all warnings should be treated as errors. This is equivalent to the -wx switch.
VerboseOutput Optional boolean parameter.

Specifies that the tool should provide verbose output. This is equivalent to the -v switch.

The following table describes the parameters that are specific to the Lit task.

Parameter Description
LibAdditionalOptions Optional string parameter.

Specifies additional command line parameters to append when calling lit.exe.
LibBindFiles Optional boolean parameter.

Specifies that the library creation tool should bind files into a .wixout file. This is only valid when the OutputAsXml parameter is also provided. This is equivalent to the -bf switch in lit.exe.
LibPedantic Optional boolean parameter.

Specifies that the library creation tool should display pedantic messages. This is equivalent to the -pedantic switch in lit.exe.
LibSuppressAllWarnings Optional boolean parameter.

Specifies that all library creation tool warnings should be suppressed. This is equivalent to the -sw switch in lit.exe.
LibSuppressIntermediateFileVersionMatching Optional boolean parameter.

Specifies that the library creation tool should suppress intermediate file version mismatch checking. This is equivalent to the -sv switch in lit.exe.
LibSuppressSchemaValidation Optional boolean parameter.

Specifies that the library creation tool should suppress schema validation of documents. This is equivalent to the -ss switch in lit.exe.
LibSuppressSpecificWarnings Optional string parameter.

Specifies that certain library creation tool warnings should be suppressed. This is equivalent to the -sw[N] switch in lit.exe.
LibTreatSpecificWarningsAsErrors Optional string parameter.

Specifies that certain library creation tool warnings should be treated as errors. This is equivalent to the -wx[N] switch in lit.exe.
LibTreatWarningsAsErrors Optional boolean parameter.

Specifies that all library creation tool warnings should be treated as errors. This is equivalent to the -wx switch in lit.exe.
LibVerboseOutput Optional boolean parameter.

Specifies that the library creation tool should provide verbose output. This is equivalent to the -v switch in lit.exe.
LinkerBindInputPaths Optional string parameter.

Specifies a binder path that the library creation tool should use to locate all files. This is equivalent to the -b <path> switch in lit.exe.
Named BindPaths are created by prefixing the 2-or-more-character bucket name followed by an equal sign ("=") to the supplied path.