BuildParameters Class

Definition

Namespace:

Microsoft.Build.Execution

Assembly:

Microsoft.Build.dll

Package:

Microsoft.Build v17.11.4

Source:

BuildParameters.cs

This class represents all of the settings which must be specified to start a build.

public ref class BuildParameters

public class BuildParameters

type BuildParameters = class

Public Class BuildParameters

Inheritance

Object

BuildParameters

Constructors

BuildParameters()	Constructor for those who intend to set all properties themselves.
BuildParameters(ProjectCollection)	Creates BuildParameters from a ProjectCollection.

Properties

AllowFailureWithoutError	Indicates whether to emit a default error if a task returns false without logging an error.
BuildProcessEnvironment	Gets the environment variables which were set when this build was created.
BuildThreadPriority	Gets or sets the desired thread priority for building.
Culture	The name of the culture to use during the build.
DefaultToolsVersion	The default tools version for the build.
DetailedSummary	When true, indicates that the build should emit a detailed summary at the end of the log.
DisableInProcNode	When true, indicates the in-proc node should not be used.
DiscardBuildResults	Determines whether MSBuild will save the results of builds after EndBuild to speed up future builds.
EnableNodeReuse	Flag indicating whether out-of-proc nodes should remain after the build and wait for further builds.
EnvironmentProperties	Gets an immutable collection of environment properties.
ForwardingLoggers	The collection of forwarding logger descriptions.
GlobalProperties	Sets or retrieves an immutable collection of global properties.
HostServices	Interface allowing the host to provide additional control over the build process.
InputResultsCacheFiles	Input cache files that MSBuild will use to read build results from. If the isolation mode is set to False, this sets the isolation mode to True.
Interactive	Gets or sets a value indicating if the build is allowed to interact with the user.
IsBuildCheckEnabled	Gets or sets an indication of build analysis enablement.
IsolateProjects	Gets or sets a value indicating the isolation mode to use.
LegacyThreadingSemantics	Enables or disables legacy threading semantics
Loggers	The collection of loggers to use during the build.
LogInitialPropertiesAndItems	When true, indicates that the initial properties and items should be logged.
LogTaskInputs	When true, indicates that the task parameters should be logged.
LowPriority	Gets or sets a value indicating whether the build process should run as low priority.
MaxNodeCount	The maximum number of nodes this build may use.
MemoryUseLimit	The amount of memory the build should limit itself to using, in megabytes.
NodeExeLocation	The location of the build node executable.
OnlyLogCriticalEvents	Flag indicating if non-critical logging events should be discarded.
OutputResultsCacheFile	Output cache file where MSBuild will write the contents of its build result caches during EndBuild. If the isolation mode is set to False, this sets the isolation mode to True.
ProjectCacheDescriptor	Gets or sets the project cache description to use for all BuildSubmission or GraphBuildSubmission in addition to any potential project caches described in each project.
ProjectIsolationMode	Gets or sets a value indicating the isolation mode to use.
ProjectLoadSettings
Question	Gets or sets a value that will error when the build process fails an incremental check.
ResetCaches	Indicates that the build should reset the configuration and results caches.
SaveOperatingEnvironment	Flag indicating if the operating environment such as the current directory and environment be saved and restored between project builds and task invocations. This should be set to false for any other build managers running in the system so that we do not have two build managers trampling on each others environment.
ShutdownInProcNodeOnBuildFinish	Shutdown the inprocess node when the build finishes. By default this is false since visual studio needs to keep the inprocess node around after the build finishes.
ToolsetDefinitionLocations	Locations to search for toolsets.
Toolsets	Returns all of the toolsets.
UICulture	The name of the UI culture to use during the build.
UseSynchronousLogging	By default if the number of processes is set to 1 we will use Asynchronous logging. However if we want to use synchronous logging when the number of cpu's is set to 1 this property needs to be set to true.
WarningsAsErrors	A list of warnings to treat as errors. To treat all warnings as errors, set this to an empty HashSet<T>.
WarningsAsMessages	A list of warnings to treat as low importance messages.
WarningsNotAsErrors	A list of warnings to not treat as errors. Only has any effect if WarningsAsErrors is empty.

Methods

Clone()	Creates a clone of this BuildParameters object. This creates a clone of the logger collections, but does not deep clone the loggers within.
GetToolset(String)	Retrieves a toolset.