Microsoft.Build.Framework

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , , , , , , , , and values.

The custom subcategory of the event. The error code of the event. The name of the file associated with the event. The line number that corresponds to the beginning of the section of code that raised the event. The column number that corresponds to the beginning of the section of code that raised the event. The line number that corresponds to the end of the section of code that raised the event. The column number that corresponds to the end of the section of code that raised the event. The text of the event. The Help keyword associated with the event. The source of the event.

Gets the error code of the event.

The error code of the event.

Gets the column number that corresponds to the beginning of the section of code that raised the event.

The column number that corresponds to the beginning of the section of code that raised the event.

Gets the column number that corresponds to the end of the section of code that raised the event.

The column number that corresponds to the end of the section of code that raised the event.

Gets the line number that corresponds to the end of the section of code that raised the event.

The line number that corresponds to the end of the section of code that raised the event.

Gets the name of the file that raised the event.

The name of the file that raised the event.

Gets the line number that corresponds to the beginning of the section of code that raised the event.

The line number that corresponds to the beginning of the section of code that raised the event.

Gets the custom subtype of the event.

The custom subtype of the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , and values.

The text of the event. The Help keyword associated with the event. The source of the event.

Gets or sets location contextual information. This is attached to logging events to define where they are located in relation to the process, engine, project, target, or task that is executing.

A object representing the location contextual information.

Gets the Help keyword for the event.

The Help keyword for the event.

Gets the message for the event.

The message for the event.

Gets the name of the raising the event.

The name of the raising the event.

Gets an integer identifier for the thread that raised the event.

An integer identifier for the thread that raised the event.

Gets the time the event was raised as a .

The time the event was raised as a .

Provides contextual location information for build events.

Initializes a new instance of the class.

The node ID of the build event. The target ID of the build event. The project ID of the build event. The task ID of the build event.

Gets whether the references are the same.

true if the references are equal, false otherwise. The reference to compare. 2

Gets a code comprised of the and the .

An integer value representing the hash code. 2

Gets whether the context where the event occurred is valid.

true if the context is valid; false otherwise.

The node ID of the target the event was in when the event was triggered.

The project ID of the target the event was in when the event was triggered.

The name of the target the event was in when the event was triggered.

The task ID of the target the event was in when the event was triggered.

Gets the node ID where the event occurred.

An integer value representing the node ID.

Gets the ID of the project where the event occurred.

An integer value representing the project ID.

Gets the ID of the target where the event occurred.

An integer value representing the target ID.

Gets the ID of the task where the event occurred.

An integer value representing the task ID.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , and values.

The text of the event. The Help keyword associated with the event. true to indicate the build succeeded; otherwise, false.

Gets or sets a value indicating whether the build succeeded.

true to indicate the build succeeded; otherwise, false.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , , and values.

The text of the event. The Help keyword associated with the event. The source of the event. A value indicating the importance of the event.

Gets the importance of the event.

A value indicating the importance of the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified message and Help keyword.

The text of the event. The Help keyword associated with the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , and values.

The text of the event. The Help keyword associated with the event. The source of the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , , , , , , , , and values.

The custom subcategory of the event. The warning code of the event. The name of the file associated with the event. The line number that corresponds to the beginning of the section of code that raised the event. The column number that corresponds to the beginning of the section of code that raised the event. The line number that corresponds to the end of the section of code that raised the event. The column number that corresponds to the end of the section of code that raised the event. The text of the event. The Help keyword associated with the event. The source of the event.

Gets the warning code of the event.

The warning code of the event.

Gets the column number that corresponds to the beginning of the section of code that raised the event.

The column number that corresponds to the beginning of the section of code that raised the event.

Gets the column number that corresponds to the end of the section of code that raised the event.

The column number that corresponds to the end of the section of code that raised the event.

Gets the line number that corresponds to the end of the section of code that raised the event.

The line number that corresponds to the end of the section of code that raised the event.

Gets the name of the file that raised the event.

The name of the file that raised the event.

Gets the line number that corresponds to the beginning of the section of code that raised the event.

The line number that corresponds to the beginning of the section of code that raised the event.

Gets the custom subcategory of the event.

The custom subcategory of the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , and values.

The text of the event. The Help keyword associated with the event. The source of the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class, with the specified values.

The text of the event. The Help keyword associated with the event. The source of the event. The project file name. true to indicate that the project built successfully; otherwise false.

Gets the project file name that raised the event.

The project file name that raised the event.

Gets a value indicating whether the build succeeded.

true if the build succeeded; otherwise, false.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class, with the specified values.

The text of the event. The Help keyword associated with the event. The source of the event. The project file name. The names of the targets to build in the external project. This can be a null reference (Nothing in Visual Basic) if the external project is being built with the default targets.

Gets the project file that raised the event.

The project file that raised the event.

Gets the target names that are being built in the project.

The names of the targets being built in the external project. This can be a null reference (Nothing in Visual Basic) if the external project is being built with the default target.

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

Initiates a build of a project file. If the build is successful, the outputs, if any, of the specified targets are returned.

true if the build was successful; otherwise, false. The name of the project file to build. The names of the target in the project to build. Separate multiple targets with a semicolon (;). An of additional global properties to apply to the project. The key and value must be String data types. The outputs of each specified target.

Gets the line number of the task node within the project file that called it.

The line number of the task node within the project file that called it.

Returns true if the ContinueOnError flag was set to true for this particular task in the project file.

true if the ContinueOnError flag was set to true for this particular task in the project file.

Gets the line number of the task node within the project file that called it.

The line number of the task node within the project file that called it.

Raises a custom event to all registered loggers.

The event data.

Raises an error event to all registered loggers.

The event data.

Raises a message event to all registered loggers.

The event data.

Raises a warning event to all registered loggers.

The event data.

Gets the full path to the project file that contained the call to this task.

The full path to the project file that contained the call to this task.

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

Initiates a build of a project file. If the build is successful, the outputs of the specified targets are returned, if any exist.

true if the build was successful; otherwise, false. The name of the project file to build. The names of the target in the project to build. Separate multiple targets with a semicolon (;). Null values are acceptable. An of additional global properties to apply to the project. The key and value must be String data types. The outputs of each specified target. Null values are acceptable. Default value = "3.5." Specifies the Toolset version for the build to use. Null values are acceptable.

Allows tasks to initiate parallel builds of the specified project files on systems with multiple processors or multiple core processors. If the builds are successful, the outputs of the specified targets are returned, if any exist.

True if the build succeeded, false if otherwise. The names of the project files to build. The names of the targets in the project to build. Separate multiple targets with a semicolon (;). Null values are acceptable. An of additional global properties to apply to the project. The key and value must be String data types. Array entries can be null. The outputs of each specified target. Null values are acceptable. Default value = "3.5." Specifies the Toolset version for the build to use. Null values are acceptable. If true, the operation runs only if the cache does not already contain the result. After the operation the result is stored in the cache. If true the project is unloaded once the operation completes.

Returns whether the system is running in single- or multi-processor mode.

true if the system is running in multi-processor mode, false otherwise.

Forwards build events to other loggers.

Called by the node loggers to forward build events to the central logger.

The to forward.

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

Occurs when a build raises any other type of build event.

2

Occurs when a build finishes.

Occurs when a build starts.

Occurs when a build raises a custom event.

2

Occurs when a build raises an error.

Occurs when a build raises a message.

Occurs when a project finishes building.

Occurs when a project starts building.

Occurs when a build raises a status event.

2

Occurs when a target finishes building.

Occurs when a target starts building.

Occurs when a task completes execution.

Occurs when a task begins execution.

Occurs when a build raises a warning.

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

Get or set by the build engine to allow node loggers to forward messages to the central logger.

An representing the event redirector to forward messages to.

Get or set by the build engine or node to inform the forwarding logger on which node it is running.

An integer representing the node ID on which the build engine is running.

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

Subscribes loggers to specific events. This method is called when the logger is registered with the build engine, before any events are raised.

The events available to loggers.

Gets or sets the user-defined parameters of the logger.

The logger parameters.

Releases the resources allocated to the logger at the time of initialization or during the build. This method is called when the logger is unregistered from the engine, after all events are raised. A host of MSBuild typically unregisters loggers immediately before quitting.

Gets or sets the level of detail to show in the event log.

One of the enumeration values. The default is .

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

An object representing the build event source. The number of CPUs.

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

Gets or sets the build engine associated with the task.

The build engine associated with the task. 2

Executes a task.

true if the task executed successfully; otherwise, false.

Gets or sets any host object that is associated with the task.

The host object associated with the task. 2

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

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

Gets the collection of custom metadata.

The collection of custom metadata. 2

Copies the custom metadata entries to another item.

The item to copy the metadata entries to. 2

Gets the value of the specified metadata entry.

The value of the metadata. The name of the metadata entry. 2

Gets or sets the item specification.

The item specification.

Gets the number of metadata entries associated with the item.

The number of metadata entries associated with the item.

Gets the names of the metadata entries associated with the item.

The names of the metadata entries associated with the item.

Removes the specified metadata entry from the item.

The name of the metadata entry to remove.

Adds or changes a custom metadata entry to the item.

The name of the metadata entry. The value of the metadata entry.

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

Initializes a new instance of the class.

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

Initializes a new instance of the class.

Initializes a new instance of the class with the values specified.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

Initializes a new instance of the class with the specified values.

The error message that explains the reason for the exception.

Initializes a new instance of the class with the values specified.

The error message that explains the reason for the exception. The exception that is the cause of the current excpetion. If the parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception.

Initializes a new instance of the class with the values specified.

The error message that explains the reason for the exception. The exception that is the cause of the current excpetion. If the parameter is not a null reference (Nothing in Visual Basic), the current exception is raised in a catch block that handles the inner exception. The error code associated with the exception's message. The Help keyword for the error.

Gets the error code associated with this exception's message.

The error code associated with this exception's message.

Sets the with information about the exception.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. 2

Gets the F1-help keyword associated with this error.

The F1-help keyword for the error.

Specifies the available verbosity levels of a .

Quiet verbosity, which displays a build summary.

Minimal verbosity, which displays errors, warnings, messages with values of , and a build summary.

Normal verbosity, which displays errors, warnings, messages with values of , some status events, and a build summary.

Detailed verbosity, which displays errors, warnings, messages with values of or , all status events, and a build summary.

Diagnostic verbosity, which displays all errors, warnings, messages, status events, and a build summary.

Specifies constants that define the importance of a build message.

A high importance message.

A normal importance message.

A low importance message.

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

Initializes a new instance of the class.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , , and values.

The text of the event. The Help keyword associated with the event. The project file associated with the event. true to indicate the build succeeded; otherwise, false.

Gets the project file associated with the event.

The project file associated with the event.

Gets a value indicating whether the build succeeded.

The value indicating whether the build succeeded.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified values.

The unique identifier for the project. The text of the event. The Help keyword associated with the event. The project file name. The targets to be built. A list of properties. A list of items. A value that defines location contextual information. This is attached to logging events to define where they are located in relation to the process, engine, project, target, or task that is executing.

Initializes a new instance of the class with the specified values.

The text of the event. The Help keyword associated with the event. The project file name. The targets to be built. A list of properties A list of items.

A value representing an invalid project ID.

Gets the list of items for the event.

The list of items for the event.

Gets the list of items for the event

A object representing the list of items for the event.

Gets the project file associated with the event.

The project file associated with the event.

Gets the project file associated with the event.

An integer representing the ID of the project file associated with the event.

Gets the list of properties for the event.

The list of properties for the event.

Gets the list of targets to be built in the project.

The list of targets to be built in the project.

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

The source of the event. A that contains the event data.

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.

Initializes a new instance of the class.

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

Initializes a new instance of the class.

The version of the CLR runtime required prefaced with a "v," such as "v2.0."

Gets the CLR runtime version the attribute was constructed with, such as "v2.0."

A string containing the CLR runtime version required.

Initializes a new instance of the class.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified , , , , and values.

The text of the event. The Help keyword associated with the event. The name of the target associated with the event. The name of the project file associated with the event. The name of the target file. true to indicate the build succeeded; otherwise, false.

Gets the name of the project file associated with the event.

the name of the project file associated with the event.

Gets a value indicating whether the build of the target succeeded.

The value indicating whether the build of the target succeeded.

Gets the name of the file that contains the implementation of this target.

The name of the file that contains the implementation of this target.

Gets the name of the target associated with the event.

The name of the target associated with the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initalizes a new instance of the class with the valudes provided.

The text of the event. The Help keyword associated with the event. The name of the target associated with the event. The name of the project file associated with the event. The name of the target file.

Gets the name of the project file associated with the event.

The name of the project file associated with the event.

Gets the name of the file that contains the implementation of this target.

The name of the file that contains the implementation of this target.

Gets the name of the target associated with the event.

The name of the target associated with the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified command line and .

The command line used by the task to run the underlying program. The name of the task raising the event. The of the message.

Gets the command line used by the task to run the underlying program.

The command line used by the task to run the underlying program.

Gets the name of the task that raised the event.

The name of the task that raised the event.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified values.

The text for the message. The Help keyword associated with the event. The project file name. The fine in which the task is defined. The name of the task. true to indicate the task succeeded; otherwise, false

Gets the name of the project file associated with the event.

The name of the project file associated with the event.

Gets a value indicating whether the execution of the task succeeded.

The value indicating whether the execution of the task succeeded.

Gets the MSBuild file where the task is defined.

The MSBuild file where the task is defined.

Gets the name of the task associated with the event.

The name of the task associated with the event.

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

The source of the event. A that contains the event data.

Provides data for the event.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified values.

The text of the event. The Help keyword associated with the event. The name of the project file associated with the event. The file in which the task is defined. The name of the task.

Gets the name of the project file associated with the event.

The name of the project file associated with the event.

Gets the MSBuild file where the task was defined.

The MSBuild file where the task was defined.

Gets the name of the task associated with the event.

The name of the task associated with the event.

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

The source of the event. A that contains the event data.