IBuildEngine2.BuildProjectFile Method

Reference

Definition

Namespace:: Microsoft.Build.Framework

Assembly:: Microsoft.Build.Framework.dll

Package:: Microsoft.Build.Framework v15.9.20

Package:: Microsoft.Build.Framework v16.11.0

Package:: Microsoft.Build.Framework v17.9.5

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This method allows tasks to initiate a build on a particular project file. If the build is successful, the outputs (if any) of the specified targets are returned.

public:
 bool BuildProjectFile(System::String ^ projectFileName, cli::array <System::String ^> ^ targetNames, System::Collections::IDictionary ^ globalProperties, System::Collections::IDictionary ^ targetOutputs, System::String ^ toolsVersion);

public bool BuildProjectFile (string projectFileName, string[] targetNames, System.Collections.IDictionary globalProperties, System.Collections.IDictionary targetOutputs, string toolsVersion);

abstract member BuildProjectFile : string * string[] * System.Collections.IDictionary * System.Collections.IDictionary * string -> bool

Public Function BuildProjectFile (projectFileName As String, targetNames As String(), globalProperties As IDictionary, targetOutputs As IDictionary, toolsVersion As String) As Boolean

Parameters

projectFileName: String

The project to build.

targetNames: String[]

The targets in the project to build (can be null).

globalProperties: IDictionary

A hash table of additional global properties to apply to the child project (can be null). The key and value should both be strings.

targetOutputs: IDictionary

The outputs of each specified target (can be null).

toolsVersion: String

A tools version recognized by the Engine that will be used during this build (can be null).

Returns

Boolean

true, if build was successful

Remarks

1) it is acceptable to pass null for both targetNames and targetOutputs 2) if no targets are specified, the default targets are built 3) target outputs are returned as ITaskItem arrays indexed by target name

Applies to