BuildParameters Class
Definition
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 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
-
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. Setting this also turns on isolated builds. |
| Interactive |
Gets or sets a value indicating if the build is allowed to interact with the user. |
| IsolateProjects |
Gets or sets a value indicating whether projects should build in isolation. |
| 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. Setting this also turns on isolated builds. |
| ProjectCacheDescriptor |
If set, the BuildManager will query all incoming BuildSubmission requests against the specified project cache. Any GraphBuildSubmission requests will also use this project cache instead of the potential project caches described in graph node's evaluations. |
| ProjectLoadSettings | |
| 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. |
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. |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetToolset(String) |
Retrieves a toolset. |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |