ProjectInstance.Build Method

Definition

Namespace:

Microsoft.Build.Execution

Assembly:

Microsoft.Build.dll

Package:

Microsoft.Build v17.11.4

Builds the default targets of the project with loggers of the project collection.

Overloads

Build(String[], IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>, IDictionary<String,TargetResult>)	Build a list of targets with specified loggers. Returns true on success, false on failure. Targets may be null. Loggers may be null. Remote loggers may be null. Only valid if mutable.
Build(String[], IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>)	Build a list of targets with specified loggers. Returns true on success, false on failure. Targets may be null. Loggers may be null. Remote loggers may be null. Only valid if mutable.
Build(String[], IEnumerable<ILogger>, IDictionary<String,TargetResult>)	Build a list of targets with specified loggers. Returns true on success, false on failure. Targets may be null. Loggers may be null. Only valid if mutable.
Build(String, IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>)	Build a target with specified loggers. Returns true on success, false on failure. Target may be null. Loggers may be null. Remote loggers may be null. Only valid if mutable.
Build(String[], IEnumerable<ILogger>)	Build a list of targets with specified loggers. Returns true on success, false on failure. Targets may be null. Loggers may be null. Only valid if mutable.
Build(String, IEnumerable<ILogger>)	Build a target with specified loggers. Returns true on success, false on failure. Target may be null. Loggers may be null. Only valid if mutable.
Build(IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>)	Build default target/s with specified loggers. Returns true on success, false on failure. Loggers may be null. Only valid if mutable.
Build(IEnumerable<ILogger>)	Build default target/s with specified loggers. Returns true on success, false on failure. Loggers may be null. Only valid if mutable.
Build()	Build default target/s with loggers of the project collection. Returns true on success, false on failure. Only valid if mutable.

Build(String[], IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>, IDictionary<String,TargetResult>)

Source:

ProjectInstance.cs

Build a list of targets with specified loggers. Returns true on success, false on failure. Targets may be null. Loggers may be null. Remote loggers may be null. Only valid if mutable.

public:
 bool Build(cli::array <System::String ^> ^ targets, System::Collections::Generic::IEnumerable<Microsoft::Build::Framework::ILogger ^> ^ loggers, System::Collections::Generic::IEnumerable<Microsoft::Build::Logging::ForwardingLoggerRecord ^> ^ remoteLoggers, [Runtime::InteropServices::Out] System::Collections::Generic::IDictionary<System::String ^, Microsoft::Build::Execution::TargetResult ^> ^ % targetOutputs);

public bool Build (string[] targets, System.Collections.Generic.IEnumerable<Microsoft.Build.Framework.ILogger> loggers, System.Collections.Generic.IEnumerable<Microsoft.Build.Logging.ForwardingLoggerRecord> remoteLoggers, out System.Collections.Generic.IDictionary<string,Microsoft.Build.Execution.TargetResult> targetOutputs);

member this.Build : string[] * seq<Microsoft.Build.Framework.ILogger> * seq<Microsoft.Build.Logging.ForwardingLoggerRecord> * IDictionary -> bool

Public Function Build (targets As String(), loggers As IEnumerable(Of ILogger), remoteLoggers As IEnumerable(Of ForwardingLoggerRecord), ByRef targetOutputs As IDictionary(Of String, TargetResult)) As Boolean

Parameters

targets

String[]

The targets to build. May be null.

loggers

IEnumerable<ILogger>

The loggers to use for the build. May be null.

remoteLoggers

IEnumerable<ForwardingLoggerRecord>

The remote loggers to use for the build. May be null.

targetOutputs

IDictionary<String,TargetResult>

The target outputs.

Returns

Boolean

true if the build succeeds; otherwise, false.

Remarks

If any of the loggers supplied are already attached to the logging service we were passed, throws InvalidOperationException.

Build(String[], IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>)

Source:

ProjectInstance.cs

Build a list of targets with specified loggers. Returns true on success, false on failure. Targets may be null. Loggers may be null. Remote loggers may be null. Only valid if mutable.

public:
 bool Build(cli::array <System::String ^> ^ targets, System::Collections::Generic::IEnumerable<Microsoft::Build::Framework::ILogger ^> ^ loggers, System::Collections::Generic::IEnumerable<Microsoft::Build::Logging::ForwardingLoggerRecord ^> ^ remoteLoggers);

public bool Build (string[] targets, System.Collections.Generic.IEnumerable<Microsoft.Build.Framework.ILogger> loggers, System.Collections.Generic.IEnumerable<Microsoft.Build.Logging.ForwardingLoggerRecord> remoteLoggers);

member this.Build : string[] * seq<Microsoft.Build.Framework.ILogger> * seq<Microsoft.Build.Logging.ForwardingLoggerRecord> -> bool

Public Function Build (targets As String(), loggers As IEnumerable(Of ILogger), remoteLoggers As IEnumerable(Of ForwardingLoggerRecord)) As Boolean

Parameters

targets

String[]

The targets to build. May be null.

loggers

IEnumerable<ILogger>

The loggers to use for the build. May be null.

remoteLoggers

IEnumerable<ForwardingLoggerRecord>

The remote loggers to use for the build. May be null.

Returns

Boolean

true if the build succeeds; otherwise, false.

Remarks

If any of the loggers supplied are already attached to the logging service we were passed, throws InvalidOperationException.

Build(String[], IEnumerable<ILogger>, IDictionary<String,TargetResult>)

Source:

ProjectInstance.cs

Build a list of targets with specified loggers. Returns true on success, false on failure. Targets may be null. Loggers may be null. Only valid if mutable.

public:
 bool Build(cli::array <System::String ^> ^ targets, System::Collections::Generic::IEnumerable<Microsoft::Build::Framework::ILogger ^> ^ loggers, [Runtime::InteropServices::Out] System::Collections::Generic::IDictionary<System::String ^, Microsoft::Build::Execution::TargetResult ^> ^ % targetOutputs);

public bool Build (string[] targets, System.Collections.Generic.IEnumerable<Microsoft.Build.Framework.ILogger> loggers, out System.Collections.Generic.IDictionary<string,Microsoft.Build.Execution.TargetResult> targetOutputs);

member this.Build : string[] * seq<Microsoft.Build.Framework.ILogger> * IDictionary -> bool

Public Function Build (targets As String(), loggers As IEnumerable(Of ILogger), ByRef targetOutputs As IDictionary(Of String, TargetResult)) As Boolean

Parameters

targets

String[]

List of targets to build. May be null.

loggers

IEnumerable<ILogger>

Enumerated list of loggers to use for building targets.

targetOutputs

IDictionary<String,TargetResult>

Outputs of target builds.

Returns

Boolean

true on success, false on failure.

Remarks

If any of the loggers supplied are already attached to the logging service we were passed, throws InvalidOperationException.

Build(String, IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>)

Source:

ProjectInstance.cs

Build a target with specified loggers. Returns true on success, false on failure. Target may be null. Loggers may be null. Remote loggers may be null. Only valid if mutable.

public:
 bool Build(System::String ^ target, System::Collections::Generic::IEnumerable<Microsoft::Build::Framework::ILogger ^> ^ loggers, System::Collections::Generic::IEnumerable<Microsoft::Build::Logging::ForwardingLoggerRecord ^> ^ remoteLoggers);

public bool Build (string target, System.Collections.Generic.IEnumerable<Microsoft.Build.Framework.ILogger> loggers, System.Collections.Generic.IEnumerable<Microsoft.Build.Logging.ForwardingLoggerRecord> remoteLoggers);

member this.Build : string * seq<Microsoft.Build.Framework.ILogger> * seq<Microsoft.Build.Logging.ForwardingLoggerRecord> -> bool

Public Function Build (target As String, loggers As IEnumerable(Of ILogger), remoteLoggers As IEnumerable(Of ForwardingLoggerRecord)) As Boolean

Parameters

target

String

The target to build. May be null.

loggers

IEnumerable<ILogger>

The loggers to use for the build. May be null.

remoteLoggers

IEnumerable<ForwardingLoggerRecord>

The remote loggers to use for the build. May be null.

Returns

Boolean

true if the build succeeds; otherwise, false.

Remarks

If any of the loggers supplied are already attached to the logging service we were passed, throws InvalidOperationException.

Build(String[], IEnumerable<ILogger>)

Source:

ProjectInstance.cs

Build a list of targets with specified loggers. Returns true on success, false on failure. Targets may be null. Loggers may be null. Only valid if mutable.

public:
 bool Build(cli::array <System::String ^> ^ targets, System::Collections::Generic::IEnumerable<Microsoft::Build::Framework::ILogger ^> ^ loggers);

public bool Build (string[] targets, System.Collections.Generic.IEnumerable<Microsoft.Build.Framework.ILogger> loggers);

member this.Build : string[] * seq<Microsoft.Build.Framework.ILogger> -> bool

Public Function Build (targets As String(), loggers As IEnumerable(Of ILogger)) As Boolean

Parameters

targets

String[]

The targets to build. May be null.

loggers

IEnumerable<ILogger>

The loggers to use for the build. May be null.

Returns

Boolean

true if the build succeeds; otherwise, false.

Remarks

If any of the loggers supplied are already attached to the logging service we were passed, throws InvalidOperationException.

Build(String, IEnumerable<ILogger>)

Source:

ProjectInstance.cs

Build a target with specified loggers. Returns true on success, false on failure. Target may be null. Loggers may be null. Only valid if mutable.

public:
 bool Build(System::String ^ target, System::Collections::Generic::IEnumerable<Microsoft::Build::Framework::ILogger ^> ^ loggers);

public bool Build (string target, System.Collections.Generic.IEnumerable<Microsoft.Build.Framework.ILogger> loggers);

member this.Build : string * seq<Microsoft.Build.Framework.ILogger> -> bool

Public Function Build (target As String, loggers As IEnumerable(Of ILogger)) As Boolean

Parameters

target

String

The target to build. May be null.

loggers

IEnumerable<ILogger>

The loggers to use for the build. May be null.

Returns

Boolean

true if the build succeeds; otherwise, false.

Remarks

If any of the loggers supplied are already attached to the logging service we were passed, throws InvalidOperationException.

Build(IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>)

Source:

ProjectInstance.cs

Build default target/s with specified loggers. Returns true on success, false on failure. Loggers may be null. Only valid if mutable.

public:
 bool Build(System::Collections::Generic::IEnumerable<Microsoft::Build::Framework::ILogger ^> ^ loggers, System::Collections::Generic::IEnumerable<Microsoft::Build::Logging::ForwardingLoggerRecord ^> ^ remoteLoggers);

public bool Build (System.Collections.Generic.IEnumerable<Microsoft.Build.Framework.ILogger> loggers, System.Collections.Generic.IEnumerable<Microsoft.Build.Logging.ForwardingLoggerRecord> remoteLoggers);

member this.Build : seq<Microsoft.Build.Framework.ILogger> * seq<Microsoft.Build.Logging.ForwardingLoggerRecord> -> bool

Public Function Build (loggers As IEnumerable(Of ILogger), remoteLoggers As IEnumerable(Of ForwardingLoggerRecord)) As Boolean

Parameters

loggers

IEnumerable<ILogger>

The loggers to use for the build. May be null.

remoteLoggers

IEnumerable<ForwardingLoggerRecord>

The remote loggers to use for the build. May be null.

Returns

Boolean

true if the build succeeds; otherwise, false.

Remarks

If any of the loggers supplied are already attached to the logging service we were passed, throws InvalidOperationException.

Build(IEnumerable<ILogger>)

Source:

ProjectInstance.cs

Build default target/s with specified loggers. Returns true on success, false on failure. Loggers may be null. Only valid if mutable.

public:
 bool Build(System::Collections::Generic::IEnumerable<Microsoft::Build::Framework::ILogger ^> ^ loggers);

public bool Build (System.Collections.Generic.IEnumerable<Microsoft.Build.Framework.ILogger> loggers);

member this.Build : seq<Microsoft.Build.Framework.ILogger> -> bool

Public Function Build (loggers As IEnumerable(Of ILogger)) As Boolean

Parameters

loggers

IEnumerable<ILogger>

The loggers to use for the build. May be null.

Returns

Boolean

true if the build succeeds; otherwise, false.

Remarks

If any of the loggers supplied are already attached to the logging service we were passed, throws InvalidOperationException.

Build()

Source:

ProjectInstance.cs

Build default target/s with loggers of the project collection. Returns true on success, false on failure. Only valid if mutable.

public:
 bool Build();

public bool Build ();

member this.Build : unit -> bool

Public Function Build () As Boolean

Returns

Boolean

true if the build succeeds; otherwise, false.