HeatProject Task

WiX Toolset

previous page next page

HeatProject Task

The HeatProject task wraps heat.exe, the WiX harvester, using the project harvesting type. 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 HeatProject task:

<HeatProject
  NoLogo="$(HarvestProjectsNoLogo)"
  SuppressAllWarnings="$(HarvestProjectsSuppressAllWarnings)"
  SuppressSpecificWarnings="$(HarvestProjectsSuppressSpecificWarnings)"
  ToolPath="$(WixToolPath)"
  TreatWarningsAsErrors="$(HarvestProjectsTreatWarningsAsErrors)"
  TreatSpecificWarningsAsErrors="$(HarvestProjectsTreatSpecificWarningsAsErrors)"
  VerboseOutput="$(HarvestProjectsVerboseOutput)"
  AutogenerateGuids="$(HarvestProjectsAutogenerateGuids)"
  GenerateGuidsNow="$(HarvestProjectsGenerateGuidsNow)"
  OutputFile="$(IntermediateOutputPath)_%(_Project.Filename).wxs"
  SuppressFragments="$(HarvestProjectsSuppressFragments)"
  SuppressUniqueIds="$(HarvestProjectsSuppressUniqueIds)"
  Transforms="%(_Project.Transforms)"
  Project="@(_Project)"
  ProjectOutputGroups="%(_Project.ProjectOutputGroups)" />

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

Parameter	Description
NoLogo	Optional boolean parameter. Specifies that the tool logo should be suppressed. The default is false. This is equivalent to the -nologo switch.
SuppressAllWarnings	Optional boolean parameter. Specifies that all warnings should be suppressed. The default is false. This is equivalent to the -sw 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. The default is false. This is equivalent to the -wx switch.
VerboseOutput	Optional boolean parameter. Specifies that the tool should provide verbose output. The default is false. This is equivalent to the -v switch.

The following table describes the parameters that are common to all heat tasks that are applicable to the HeatProject task.

Parameter	Description
AutogenerateGuids	Optional boolean parameter. Whether to generate authoring that relies on auto-generation of component GUIDs. The default is $(HarvestAutogenerateGuids) if specified; otherwise, true.
GenerateGuidsNow	Optional boolean parameter. Whether to generate authoring that generates durable GUIDs when harvesting. The default is $(HarvestGenerateGuidsNow) if specified; otherwise, false.
OutputFile	Required item parameter. Specifies the output file that contains the generated authoring.
SuppressFragments	Optional boolean parameter. Whether to suppress generation of separate fragments when harvesting. The default is $(HarvestSuppressFragments) if specified; otherwise, true.
SuppressUniqueIds	Optional boolean parameter. Whether to suppress generation of unique component IDs. The default is $(HarvestSuppressUniqueIds) if specified; otherwise, false.
Transforms	Optional string parameter. XSL transforms to apply to all generated WiX authoring. Separate multiple transforms with semicolons. The default is $(HarvestTransforms) if specified.

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

Parameter	Description
Project	Required item group parameter. The list of projects to harvest.
ProjectOutputGroups	Optional string parameter. The project output groups to harvest. Separate multiple output groups with semicolons. Examples include "Binaries" and "Source".

previous page start next page