VCBuild Task
Wraps vcbuild.exe, which builds Visual C++ projects and solutions which contain Visual C++ projects. For more information, see VCBUILD Reference.
Parameters
The following table describes the parameters of the VCBuild task.
Parameter |
Description |
|---|---|
AdditionalLibPaths |
Optional ITaskItem[] parameter. Specifies additional paths to append to the LIBPATH environment variable before executing vcbuild.exe. |
AdditionalOptions |
Optional String parameter. Specifies additional command-line switches that do not have dedicated task parameters. |
Clean |
Optional Boolean parameter. If true, specifies that the task output only clean build outputs. If the Rebuild parameter is true, it overrides this parameter. |
Configuration |
Optional String parameter. Specifies the name of the configuration and platform to build with. For example: Debug|Win32. This parameter can also be used to specify only the configuration name. |
Override |
Optional ITaskItem parameter. Specifies the location of a VCBuild property sheet file that overrides project file settings. |
Platform |
Optional String parameter. Specifies the name of the platform to build for. |
Projects |
Required ITaskItem[] parameter. Specifies the projects to build. |
Rebuild |
Optional Boolean parameter. If true, specifies that the task clean builds outputs before performing a build. This parameter overrides the Clean parameter. |
SolutionFile |
Optional ITaskItem parameter. Specifies the full path to the solution file when building solutions. This parameter is used to resolve solution-related Visual C++ project macros. |
Timeout |
Optional Int32 parameter. Specifies the amount of time, in milliseconds, after which the task executable is terminated. The default value is Int.MaxValue, indicating that there is no time out period. |
ToolPath |
Optional String parameter. Specifies the location from where the task loads the underlying executable file (vcbuild.exe). If this parameter is not specified, the task uses the SDK installation path corresponding to the version of the framework that is running MSBuild. |
UseEnvironment |
Optional Boolean parameter. true to use environment variables for INCLUDE and LIB paths; otherwise, false. |
AdditionalLinkLibraryPaths |
Optional String parameter. Specifies additional reference locations to append to the LIB environment variable. Link.exe uses the LIB path when it searches for a file specified on the Link command line, such as an object or library. Lib.exe does not use an environment variable. |
Example
The following example uses the VCBuild task to build the projects specified by the vcprojects item collection.
<VCBuild
Projects="@(vcprojects)"
Configuration="$(configuration)"
Rebuild="true"/>