NAntContrib Help Task Reference <vb6> | v0.93-nightly-2015-02-12 |
[This is preliminary documentation and subject to change.]
Compiles Microsoft Visual Basic 6 programs.
Uses the VB6.EXE executable included with the Visual Basic 6 environment.
The compiler uses the settings and source files specified in the project or group file.
Attribute | Type | Description | Required |
---|---|---|---|
project | file | Visual Basic project or group file. | True |
checkreferences | bool | Determines whether project references are checked when deciding whether the project needs to be recompiled. The default is true. | False |
compiledproperty | string | The name of a property in which will be set to true if compilation was needed and done without errors (default: "vb6.compiled") This can be used for touching the compilation files if vb6 autoincrement is set to true to avoid recompilation without any other changes. | False |
conditionals | string | Tells Visual Basic which values to use for conditional compilation constants. | False |
errorfile | file | The file to which the Visual Basic compiler should log errors. | False |
outdir | directory | Output directory for the compilation target. | 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 |
Attribute | Type | Description | Required |
---|---|---|---|
exename | string | The name of the executable that should be used to launch the external program. | False |
managed | ManagedExecution | Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. | False |
useruntimeengine | bool | Deprecated. Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false. | False |
Represents a command-line argument.
When passed to an external application, the argument will be quoted when appropriate. This does not apply to the line
parameter, which is always passed as is.
Attribute | Type | Description | Required |
---|---|---|---|
dir | directory | The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. | False |
file | file | The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. | False |
if | bool | Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true. | False |
line | string | List of command-line arguments; will be passed to the executable as is. | False |
path | <path> | The value for a PATH-like command-line argument; you can use : or ; as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. | False |
unless | bool | Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false. | False |
value | string | A single command-line argument; can contain space characters. | False |
A single command-line argument containing a space character.
<arg value="-l -a" />
Two separate command-line arguments.
<arg line="-l -a" />
A single command-line argument with the value \dir;\dir2;\dir3
on DOS-based systems and /dir:/dir2:/dir3
on Unix-like systems.
<arg path="/dir;/dir2:\dir3" />
Build the project HelloWorld.vbp
in the build
directory.
<vb6 project="HelloWorld.vbp" outdir="build" />
Check compiled property "vb6.compiled"
<echo message="Compiled sucessfully" if="${vb6.compiled}" /> <echo message="Compilation not needed" if="${not vb6.compiled}" />