Microsoft.Build.Framework Namespace

The Microsoft.Build.Framework namespace contains the types that define how tasks and loggers interact with the MSBuild engine. For information, see MSBuild.

Classes

BuildErrorEventArgs

Provides data for the ErrorRaised event.

BuildEventArgs

Provides data for the AnyEventRaised event.

BuildEventContext

Provides contextual location information for build events.

BuildFinishedEventArgs

Provides data for the BuildFinished event.

BuildMessageEventArgs

Provides data for the MessageRaised event.

BuildStartedEventArgs

Provides data for the BuildStarted event.

BuildStatusEventArgs

Provides data for the StatusEventRaised event.

BuildWarningEventArgs

Provides data for the WarningRaised event.

CriticalBuildMessageEventArgs

Contains arguments for critical message events. These always have high importance.

CustomBuildEventArgs

Provides data for the CustomEventRaised event.

ExternalProjectFinishedEventArgs

Provides data for the CustomEventRaised event.

ExternalProjectStartedEventArgs

Provides data for the CustomEventRaised event.

LazyFormattedBuildEventArgs

Stores strings for parts of a message delaying the formatting until it needs to be shown.

LoadInSeparateAppDomainAttribute

Defines the metadata attribute that MSBuild uses to identify tasks that must be executed in their own application domains.

LoggerException

Allows a logger to force the build to stop in an explicit way.

OutputAttribute

Defines the metadata attribute that task authors use to identify task properties that output data from the task.

ProjectFinishedEventArgs

Provides data for the ProjectFinished event.

ProjectStartedEventArgs

Provides data for the ProjectStarted event.

RequiredAttribute

Defines the metadata attribute that task authors use to identify required task properties. Task properties with this attribute must have a set value when the task is run.

RequiredRuntimeAttribute

Defines the metadata attribute that task authors use to identify whether the task requires a specific version of the CLR runtime.

RunInMTAAttribute

This attribute is used to mark a task class as explicitly not being required to run in the STA for COM.

RunInSTAAttribute

This attribute is used to mark a task class as being required to run in a Single Threaded Apartment for COM.

TargetFinishedEventArgs

Initializes a new instance of the TargetFinishedEventArgs class.

TargetStartedEventArgs

Provides data for the TargetStarted event.

TaskCommandLineEventArgs

Provides data for the MessageRaised event.

TaskFinishedEventArgs

Provides data for the TaskFinished event.

TaskPropertyInfo

Represents the parameter information from the using task as a strongly typed class.

TaskStartedEventArgs

Provides data for the TaskStarted event.

Structs

BuildEngineResult

Contains the result of the build and the target outputs.

Interfaces

IBuildEngine

Provides a way for task authors to use a subset of the functionality of the MSBuild engine.

IBuildEngine2

Provides a way for task authors to use a subset of the functionality of the MSBuild engine.

IBuildEngine3

This interface extends IBuildEngine to provide a method allowing building project files in parallel.

IBuildEngine4

This interface extends IBuildEngine to provide a mechanism allowing tasks to share data between task invocations.

ICancelableTask

Interface for tasks which can be cancelled.

IEventRedirector

Forwards build events to other loggers.

IEventSource

Defines the events raised by the build engine. Loggers receive an object implementing this interface in their Initialize(IEventSource) method and use it to subscribe to the events they are interested in receiving.

IForwardingLogger

Extends the ILogger interface to provide properties to forward events to a logger running in a different process. It can also be used create filtering loggers.

IGeneratedTask

An interface implemented by tasks that are generated by ITaskFactory instances.

ILogger

Defines an MSBuild logger, which subscribes to build system events.

INodeLogger

Defines a "parallel aware logger" in the build system.

ITask

Defines a task, which is a unit of executable code used by MSBuild to perform build operations.

ITaskFactory

Interface that a task factory Instance should implement.

ITaskFactory2

Describes and extended ITaskFactory interface that a task factory instance should implement.

ITaskHost

Passes host objects from an integrated development environment (IDE) to individual tasks.

ITaskItem

Defines an MSBuild item that can be consumed and emitted by tasks.

ITaskItem2

This interface adds escaping support to the ITaskItem interface.

Enums

LoggerVerbosity

Specifies the available verbosity levels of a Logger.

MessageImportance

Specifies constants that define the importance of a build message.

RegisteredTaskObjectLifetime

Defines the lifetime of a registered task object.

Delegates

AnyEventHandler

Represents the method that will handle the AnyEventRaised event of a build.

BuildErrorEventHandler

Represents the method that will handle the ErrorRaised event of a build.

BuildFinishedEventHandler

Represents the method that will handle the BuildFinished event of a build.

BuildMessageEventHandler

Represents the method that will handle the MessageRaised event of a build.

BuildStartedEventHandler

Represents the method that will handle the BuildStarted event of a build.

BuildStatusEventHandler

Represents the method that will handle the StatusEventRaised event of a build.

BuildWarningEventHandler

Represents the method that will handle the WarningRaised event of a build.

CustomBuildEventHandler

Represents the method that will handle the CustomEventRaised event of a build.

ProjectFinishedEventHandler

Represents the method that will handle the ProjectFinished event of a build.

ProjectStartedEventHandler

Represents the method that will handle the ProjectStarted event of a build.

TargetFinishedEventHandler

Represents the method that will handle the TargetFinished event of a build.

TargetStartedEventHandler

Represents the method that will handle the TargetStarted event of a build.

TaskFinishedEventHandler

Represents the method that will handle the TaskFinished event of a build.

TaskStartedEventHandler

Represents the method that will handle the TaskStarted event of a build.