Build the Same Sources With Different Options

When you build projects, it is often necessary to compile the same components with different build options. For example, you can create a Debug build with symbol information or a Release build with no symbol information but with optimizations enabled. Or you can build a project to run on a specific platform such as x86 or x64. In all these cases, most of the build options stay the same; only a few options are changed to control the build configuration. With MSBuild, you use properties and conditions to create the different build configurations.
In this example, the "Hello World" project contains two new property groups that can be used to create a Debug build and a Release build.

Property Element

The syntax of the Property element is: <Name>Value</Name>, for example, <Flavor>DEBUG</Flavor>.

Property names are not case sensitive. All the following names are equivalent in an MSBuild project file: $(File), $(FILE), and $(file).''
The Property element can be used to define a variable that is referenced several times in the project file, such as the location of a temporary directory, or to set the values for properties that are used in several configurations, such as a Debug build and a Release build. For example, a project file contains the following properties:.

<Name>MyApp</Name>
<Extension>.exe</Extension>

that are then referenced in the File property by using the syntax $(*PropertyName*):

<File>$(Path)$(Name)$(Extension)</File>

When you build the project, the $(*PropertyName*) syntax is replaced with the property value. If a property has not been defined, $(*PropertyName*) resolves to an empty string. In this example, the Path property has not been defined, therefore File=MyApp.exe.

Specifying Properties on the Command Line

Properties can be specified on the command line using the /property switch:

msbuild <file name>.proj /property:Flavor=Debug

The /property switch can be shortened to /p and can specify more than one property. For example, to set the value of the Flavor property and the value of the Platform property, type:

msbuild <file name>.proj /p:Flavor=Debug;Platform=x86
or
msbuild <file name>.proj /p:Flavor=Debug /p:Platform=x86

Specifying Properties Using Environment Variables

Environment variables are also treated as properties and are automatically incorporated by MSBuild.

Order of Precedence for Properties

The property value that is specified on the command line takes precedence over any value that is set for the same property in the project file, and that value in the project file takes precedence over the value in an environment variable.

PropertyGroup Element

In the project file, a PropertyGroup element is required as the container for properties, such as:

<PropertyGroup Condition="'$(Flavor)'=='DEBUG'">
<DebugType>full</DebugType>
<Optimize>no</Optimize>
</PropertyGroup>

Condition Attribute

The Condition attribute can be used with many elements in a project file. A condition can be used to enable or disable one property, for example, if the value of the Flavor property is DEBUG, the DebugType property is defined:

<DebugType Condition="'$(Flavor)'=='DEBUG'">full</DebugType>

A condition can also be used at the PropertyGroup level which enables or disables all the properties contained within it, for example:

<PropertyGroup Condition="'$(Flavor)'=='DEBUG'">
<DebugType>full</DebugType>
<Optimize>off</Optimize>
</PropertyGroup>

Property groups are especially useful when you want to apply the same condition to a large number of properties in a project file.
Four kinds of conditions can be used in a project file:
* equal
* not equal
* exists
* not exists

Condition Syntax

For all conditions, the evaluated text is enclosed in single quotes.

Evaluation of conditions is not case sensitive. The following conditions are equivalent in an MSBuild project file

Condition="'$(Flavor)'=='DEBUG'"

and

Condition="'$(flavor)'=='debug'"

Equal Condition

Syntax:
Condition="'<some text>'=='<some text>'"

Example:
<DebugType Condition="'$(Flavor)'=='DEBUG'">full</DebugType>

Not Equal Condition

Syntax:
Condition="'<some text>'!='<some text>'"

Example:
<Optimize Condition="'$(Flavor)'!='DEBUG'">on</Optimize>

Exists Condition

Instead of evaluating text, the exists and not exists conditions use the file system to determine whether a file exists. The <text> must refer to an actual file location and name; otherwise the condition equals false.
Syntax:
Condition="Exists('<text>')"
Example:
<MyAppHasBuilt Condition="Exists('MyApp.exe')">yes</MyAppHasBuilt>

Not Exists Condition

Syntax:
Condition="!Exists('<text>')"
Example:
<MyAppHasBuilt Condition="!Exists('MyApp.exe')">no</MyAppHasBuilt>

Building a Project

To build the DEBUG version of this project, type:

msbuild consolehwcs1.proj /p:flavor=debug

To build the RETAIL version of this project, use:

msbuild consolehwcs1.proj /p:flavor=retail

Project Files

Download Code - C#
Download Code - VB

Visual C# example

		    <Project [MSBuildVersion] = "2.0" [DefaultTargets] = "Compile" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

		        <!-- The default flavor if an environment variable called Flavor is not set, or if the flavor is not specified on the command line -->
		        [<PropertyGroup>]
		            <Flavor Condition="'$(Flavor)'==''">DEBUG</Flavor>
		        [</PropertyGroup>]

		        <!-- Define the DEBUG settings -->
		        [<PropertyGroup] Condition="'$(Flavor)'=='DEBUG'">
		            [<DebugType>full</DebugType>]
		            <Optimize>no</Optimize>
		        [</PropertyGroup>]

		        <!-- Define the RETAIL settings -->
		        [<PropertyGroup] Condition="'$(Flavor)'=='RETAIL'">
		            [<DebugType>pdbonly</DebugType>]
		            <Optimize>yes</Optimize>
		        [</PropertyGroup>]

		        <!-- Set the application name as a property -->
		        [<PropertyGroup>]
		            [<appname>HelloWorldCS</appname>]
		        [</PropertyGroup>]

		        <!-- Specify the inputs by type and file name -->
		        [<ItemGroup>]
		            [<CSFile] Include = "consolehwcs1.cs"/>
		        [</ItemGroup>]

		        <Target Name = "Compile">
		            <!-- Run the Visual C# compilation using input files of type [CSFile] -->
		            <CSC  Sources = "@(CSFile)"
		                DebugType="$(DebugType)"
		                Optimize="$(Optimize)"
		                OutputAssembly="$(appname).exe" >

		                <!-- Set the [OutputAssembly] attribute of the CSC task to the name of the executable file that is created -->
		                <Output [TaskParameter] = "OutputAssembly" [ItemName] = "EXEFile" />
		            </CSC>

		            <!-- Log the file name of the output file -->
		            <Message Text="The output file is @(EXEFile)"/>
		        </Target>

		    </Project>

Visual Basic example

		    <Project MSBuildVersion="2.0" [DefaultTargets] = "Compile" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" >

		        <!-- The default flavor if an environment variable called Flavor is not set, or if the flavor is not specified on the command line -->
		        [<PropertyGroup>]
		            <Flavor Condition="'$(Flavor)'==''">DEBUG</Flavor>
		        [</PropertyGroup>]

		        <!-- Define the DEBUG settings -->
		        [<PropertyGroup] Condition="'$(Flavor)'=='DEBUG'">
		            [<DebugType>full</DebugType>]
		            <Optimize>no</Optimize>
		        [</PropertyGroup>]

		        <!-- Define the RETAIL settings -->
		        [<PropertyGroup] Condition="'$(Flavor)'=='RETAIL'">
		            [<DebugType>pdbonly</DebugType>]
		            <Optimize>yes</Optimize>
		        [</PropertyGroup>]

		        <!-- Set the application name as a property -->
		        [<PropertyGroup>]
		            [<appname>HelloWorldVB</appname>]
		        [</PropertyGroup>]

		        <!-- Specify the inputs by type and file name -->
		        [<ItemGroup>]
		            [<VBFile] Include = "consolehwvb1.vb"/>
		        [</ItemGroup>]

		        <Target Name = "Compile">
		            <!-- Run the Visual Basic compilation using input files of type [VBFile] -->
		            <VBC	Sources = "@(VBFile)"

DebugType = "$(DebugType)"
Optimize = "$(Optimize)"

		                    OutputAssembly="$(appname).exe" >

		                <!-- Set the [OutputAssembly] attribute of the VBC task to the name of the executable file that is created -->
		                [<OutputItem]  [TaskParameter] = "OutputAssembly" Type = "EXEFile" />
		            </VBC>
		            <!-- Log the file name of the output file -->	
		            <Message Text="The output file is @(EXEFile)"/>
		        </Target>
		    </Project>

%21 Build the Same Sources With Different Options
When you build projects%2c it is often necessary to compile the same components with different build options. For example%2c you can create a Debug build with symbol information or a Release build with no symbol information but with optimizations enabled. Or you can build a project to run on a specific platform such as x86 or x64. In all these cases%2c most of the build options stay the same%3b only a few options are changed to control the build configuration. With %5bMSBuild%2c%5d you use properties and conditions to create the different build configurations.
In this example%2c the %22Hello World%22 project contains two new property groups that can be used to create a Debug build and a Release build.
 
%21%21 Property Element
The syntax of the *Property* element is%3a %3cName%3eValue%3c/Name%3e%2c for example%2c %3cFlavor%3eDEBUG%3c/Flavor%3e.
 
*Property* names are not case sensitive. All the following names are equivalent in an %5bMSBuild%5d project file%3a %24%28File%29%2c %24%28FILE%29%2c and %24%28file%29.%27%27
The *Property* element can be used to define a variable that is referenced several times in the project file%2c such as the location of a temporary directory%2c or to set the values for properties that are used in several configurations%2c such as a Debug build and a Release build. For example%2c a project file contains the following properties%3a.
	
	%5b%3cName%3eMyApp%3c/Name%3e%5d
	%3cExtension%3e.exe%3c/Extension%3e
 
that are then referenced in the File property by using the syntax %24%28**PropertyName**%29%3a
 
	%3cFile%3e%24%28Path%29%24%28Name%29%24%28Extension%29%3c/File%3e
 
When you build the project%2c the %24%28**PropertyName**%29 syntax is replaced with the property value. If a property has not been defined%2c %24%28**PropertyName**%29 resolves to an empty string. In this example%2c the Path property has not been defined%2c therefore %5bFile%3dMyApp.exe.%5d
 
%21%21%21 Specifying Properties on the Command Line
Properties can be specified on the command line using the /property switch%3a
 
	msbuild %3cfile name%3e.proj /property%3aFlavor%3dDebug
 
The /property switch can be shortened to /p and can specify more than one property. For example%2c to set the value of the Flavor property and the value of the Platform property%2c type%3a
 
	msbuild %3cfile name%3e.proj /p%3aFlavor%3dDebug%3bPlatform%3dx86
or
	msbuild %3cfile name%3e.proj /p%3aFlavor%3dDebug /p%3aPlatform%3dx86
 
%21%21%21 Specifying Properties Using Environment Variables
 
Environment variables are also treated as properties and are automatically incorporated by %5bMSBuild.%5d 
 
%21%21%21 Order of Precedence for Properties
The property value that is specified on the command line takes precedence over any value that is set for the same property in the project file%2c and that value in the project file takes precedence over the value in an environment variable.
 
%21%21 PropertyGroup Element
 
In the project file%2c a *PropertyGroup* element is required as the container for properties%2c such as%3a
	
	%5b%3cPropertyGroup%5d Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27DEBUG%27%22%3e
		%5b%3cDebugType%3efull%3c/DebugType%3e%5d
		%3cOptimize%3eno%3c/Optimize%3e
	%5b%3c/PropertyGroup%3e%5d
 
%21%21 Condition Attribute
The *Condition* attribute can be used with many elements in a project file. A condition can be used to enable or disable one property%2c for example%2c if the value of the Flavor property is DEBUG%2c the %5bDebugType%5d property is defined%3a
 
	%5b%3cDebugType%5d Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27DEBUG%27%22%3efull%3c/DebugType%3e
 
A condition can also be used at the *PropertyGroup* level which enables or disables all the properties contained within it%2c for example%3a
 
	%5b%3cPropertyGroup%5d Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27DEBUG%27%22%3e
	%5b%3cDebugType%3efull%3c/DebugType%3e%5d
	%3cOptimize%3eoff%3c/Optimize%3e
	%5b%3c/PropertyGroup%3e%5d
 
Property groups are especially useful when you want to apply the same condition to a large number of properties in a project file.
Four kinds of conditions can be used in a project file%3a
	* equal 
	* not equal 
	* exists 
	* not exists 
 
%21%21%21 Condition Syntax
For all conditions%2c the evaluated text is enclosed in single quotes.
 
_Evaluation of conditions is not case sensitive. The following conditions are equivalent in an %5bMSBuild%5d project file_ 
	
	Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27DEBUG%27%22
%7b%7b
 and 
%7d%7d
	Condition%3d%22%27%24%28flavor%29%27%3d%3d%27debug%27%22
 
%21%21%21 Equal Condition
 
Syntax%3a 
	Condition%3d%22%27%3csome text%3e%27%3d%3d%27%3csome text%3e%27%22
 
Example%3a
	%5b%3cDebugType%5d Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27DEBUG%27%22%3efull%3c/DebugType%3e
 
%21%21%21 Not Equal Condition
 
Syntax%3a 		
	Condition%3d%22%27%3csome text%3e%27%21%3d%27%3csome text%3e%27%22
 
Example%3a 	
	%3cOptimize Condition%3d%22%27%24%28Flavor%29%27%21%3d%27DEBUG%27%22%3eon%3c/Optimize%3e
 
%21%21%21 Exists Condition
 
Instead of evaluating text%2c the exists and not exists conditions use the file system to determine whether a file exists. The %3ctext%3e must refer to an actual file location and name%3b otherwise the condition equals false.
Syntax%3a 
	Condition%3d%22Exists%28%27%3ctext%3e%27%29%22
Example%3a 
	%5b%3cMyAppHasBuilt%5d  Condition%3d%22Exists%28%27MyApp.exe%27%29%22%3eyes%3c/MyAppHasBuilt%3e 
 
%21%21%21 Not Exists Condition
 
Syntax%3a 
	Condition%3d%22%21Exists%28%27%3ctext%3e%27%29%22
Example%3a 
	%5b%3cMyAppHasBuilt%5d Condition%3d%22%21Exists%28%27MyApp.exe%27%29%22%3eno%3c/MyAppHasBuilt%3e
 
%21%21 Building a Project
To build the DEBUG version of this project%2c type%3a
	
	msbuild consolehwcs1.proj /p%3aflavor%3ddebug
 
To build the RETAIL version of this project%2c use%3a
 
	msbuild consolehwcs1.proj /p%3aflavor%3dretail
 
%21%21 Project Files 
%5burl%3aDownload Code - C%23%7chttp%3a//faisal.members.winisp.net/msbuild/quickstarts/BuildTheSameSourcesWithDifferentOptionsCS.zip%5d
%5burl%3aDownload Code - VB%7chttp%3a//faisal.members.winisp.net/msbuild/quickstarts/BuildTheSameSourcesWithDifferentOptionsVB.zip%5d
 
%21%21%21 Visual C%23 example
%7b%7b
    %3cProject %5bMSBuildVersion%5d %3d %222.0%22 %5bDefaultTargets%5d %3d %22Compile%22 xmlns%3d%22http%3a//schemas.microsoft.com/developer/msbuild/2003%22%3e
%7d%7d
 
%7b%7b
        %3c%21-- The default flavor if an environment variable called Flavor is not set%2c or if the flavor is not specified on the command line --%3e
        %5b%3cPropertyGroup%3e%5d
            %3cFlavor Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27%27%22%3eDEBUG%3c/Flavor%3e
        %5b%3c/PropertyGroup%3e%5d
%7d%7d
 
%7b%7b
        %3c%21-- Define the DEBUG settings --%3e
        %5b%3cPropertyGroup%5d Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27DEBUG%27%22%3e
            %5b%3cDebugType%3efull%3c/DebugType%3e%5d
            %3cOptimize%3eno%3c/Optimize%3e
        %5b%3c/PropertyGroup%3e%5d
%7d%7d
 
%7b%7b
        %3c%21-- Define the RETAIL settings --%3e
        %5b%3cPropertyGroup%5d Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27RETAIL%27%22%3e
            %5b%3cDebugType%3epdbonly%3c/DebugType%3e%5d
            %3cOptimize%3eyes%3c/Optimize%3e
        %5b%3c/PropertyGroup%3e%5d
%7d%7d
 
%7b%7b
        %3c%21-- Set the application name as a property --%3e
        %5b%3cPropertyGroup%3e%5d
            %5b%3cappname%3eHelloWorldCS%3c/appname%3e%5d
        %5b%3c/PropertyGroup%3e%5d
%7d%7d
 
%7b%7b
        %3c%21-- Specify the inputs by type and file name --%3e
        %5b%3cItemGroup%3e%5d
            %5b%3cCSFile%5d Include %3d %22consolehwcs1.cs%22/%3e
        %5b%3c/ItemGroup%3e%5d
%7d%7d
 
%7b%7b
        %3cTarget Name %3d %22Compile%22%3e
            %3c%21-- Run the Visual C%23 compilation using input files of type %5bCSFile%5d --%3e
            %3cCSC  Sources %3d %22@%28CSFile%29%22
                DebugType%3d%22%24%28DebugType%29%22
                Optimize%3d%22%24%28Optimize%29%22
                OutputAssembly%3d%22%24%28appname%29.exe%22 %3e
%7d%7d
 
%7b%7b
                %3c%21-- Set the %5bOutputAssembly%5d attribute of the CSC task to the name of the executable file that is created --%3e
                %3cOutput %5bTaskParameter%5d %3d %22OutputAssembly%22 %5bItemName%5d %3d %22EXEFile%22 /%3e
            %3c/CSC%3e
%7d%7d
        
%7b%7b
            %3c%21-- Log the file name of the output file --%3e
            %3cMessage Text%3d%22The output file is @%28EXEFile%29%22/%3e
        %3c/Target%3e
%7d%7d
        
%7b%7b
    %3c/Project%3e
%7d%7d
 
%21%21%21 Visual Basic example
%7b%7b
    %3cProject MSBuildVersion%3d%222.0%22 %5bDefaultTargets%5d %3d %22Compile%22 xmlns%3d%22http%3a//schemas.microsoft.com/developer/msbuild/2003%22 %3e
%7d%7d
 
%7b%7b
        %3c%21-- The default flavor if an environment variable called Flavor is not set%2c or if the flavor is not specified on the command line --%3e
        %5b%3cPropertyGroup%3e%5d
            %3cFlavor Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27%27%22%3eDEBUG%3c/Flavor%3e
        %5b%3c/PropertyGroup%3e%5d
%7d%7d
 
%7b%7b
        %3c%21-- Define the DEBUG settings --%3e
        %5b%3cPropertyGroup%5d Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27DEBUG%27%22%3e
            %5b%3cDebugType%3efull%3c/DebugType%3e%5d
            %3cOptimize%3eno%3c/Optimize%3e
        %5b%3c/PropertyGroup%3e%5d
%7d%7d
 
%7b%7b
        %3c%21-- Define the RETAIL settings --%3e
        %5b%3cPropertyGroup%5d Condition%3d%22%27%24%28Flavor%29%27%3d%3d%27RETAIL%27%22%3e
            %5b%3cDebugType%3epdbonly%3c/DebugType%3e%5d
            %3cOptimize%3eyes%3c/Optimize%3e
        %5b%3c/PropertyGroup%3e%5d
%7d%7d
 
%7b%7b
        %3c%21-- Set the application name as a property --%3e
        %5b%3cPropertyGroup%3e%5d
            %5b%3cappname%3eHelloWorldVB%3c/appname%3e%5d
        %5b%3c/PropertyGroup%3e%5d
%7d%7d
 
%7b%7b
        %3c%21-- Specify the inputs by type and file name --%3e
        %5b%3cItemGroup%3e%5d
            %5b%3cVBFile%5d Include %3d %22consolehwvb1.vb%22/%3e
        %5b%3c/ItemGroup%3e%5d
%7d%7d
 
%7b%7b
        %3cTarget Name %3d %22Compile%22%3e
            %3c%21-- Run the Visual Basic compilation using input files of type %5bVBFile%5d --%3e
            %3cVBC	Sources %3d %22@%28VBFile%29%22
%7d%7d
		            %5bDebugType%5d %3d %22%24%28DebugType%29%22
		            Optimize %3d %22%24%28Optimize%29%22
%7b%7b
                    OutputAssembly%3d%22%24%28appname%29.exe%22 %3e
%7d%7d
            		
%7b%7b
                %3c%21-- Set the %5bOutputAssembly%5d attribute of the VBC task to the name of the executable file that is created --%3e
                %5b%3cOutputItem%5d  %5bTaskParameter%5d %3d %22OutputAssembly%22 Type %3d %22EXEFile%22 /%3e
            %3c/VBC%3e
            %3c%21-- Log the file name of the output file --%3e	
            %3cMessage Text%3d%22The output file is @%28EXEFile%29%22/%3e
        %3c/Target%3e
    %3c/Project%3e
%7d%7d

buildthesamesourceswithdifferentoptions