<hxcomp>

[This is preliminary documentation and subject to change.]

Compiles a Microsoft HTML Help 2.0 Project.

Parameters

Attribute Type Description Required
contents string The name of the contents (.HxC) file. False
logfile string ANSI/DBCS log filename. False
noerrors bool Generate no error messages. False
noinformation bool Generate no informational messages. False
nowarnings bool Generate no warning messages. False
output string Output (.HxS) filename. False
projectroot string Root directory containing Help 2.0 project files. False
uncompilefile string File to be decompiled. False
uncompileoutputdir string Directory to place decompiled files into. False
unicodelogfile string Unicode log filename. False
failonerror bool Determines if task failure stops the build, or is just reported. The default is true. False
if bool If true then the task will be executed; otherwise, skipped. The default is true. False
timeout int The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. False
unless bool Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. False
verbose bool Determines whether the task should report detailed build log messages. The default is false. False

Framework-configurable parameters

Attribute Type Description Required
exename string The name of the executable that should be used to launch the external program. False
useruntimeengine bool Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. False

Nested Elements:

<arg>

The command-line arguments for the external program.

Contains a collection of Argument elements.

</arg>

Examples

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.1793.0)