Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

HeatParams

Record Fields

Record FieldDescription
AdditionalHeatArgs
Signature: string list
AutoGenerateGuid
Signature: bool

Auto generate component guids at compile time, e.g. set Guid="*". (Parameter: -ag)

ComponentGroupName
Signature: string

Component group name, cannot contain spaces. (Parameter: -cg)

DirectoryReference
Signature: string

Directory reference to root directories, cannot contains spaces. (Parameter: -dr)

GenerateGuidNow
Signature: bool

Generate guids now. All components are given a guid when heat is run. (Parameter: -gg)

SupressComElements
Signature: bool

Suppress COM elements. (Parameter: -scom)

SupressDirectoryFragments
Signature: bool

Suppress generation of fragments for directories and components. (Parameter: -sfrag)

SupressRegistry
Signature: bool

Suppress registry harvesting. (Parameter: -sreg)

SupressRootDirectory
Signature: bool

Suppress harvesting the root directory as an element. (Parameter: -srd)

SupressUniqueIds
Signature: bool

Suppress unique identifiers for files, components, & directories.(Parameter: -suid)

TimeOut
Signature: TimeSpan

Timeout for the call to Heat

ToolDirectory
Signature: string

Directory that contains the Heat tool

VariableName
Signature: string

Substitute File/@Source="SourceDir" with a preprocessor or a wix variable (Parameter: -var)