IBuildEngine5 Interface

Definition

Namespace:

Microsoft.Build.Framework

Assembly:

Microsoft.Build.Framework.dll

Package:

Microsoft.Build.Framework v17.11.4

Source:

IBuildEngine5.cs

This interface extends IBuildEngine to log telemetry.

public interface class IBuildEngine5 : Microsoft::Build::Framework::IBuildEngine4

public interface IBuildEngine5 : Microsoft.Build.Framework.IBuildEngine4

type IBuildEngine5 = interface
    interface IBuildEngine4
    interface IBuildEngine3
    interface IBuildEngine2
    interface IBuildEngine

Public Interface IBuildEngine5
Implements IBuildEngine4

Derived

Microsoft.Build.Framework.IBuildEngine10

Microsoft.Build.Framework.IBuildEngine6

Microsoft.Build.Framework.IBuildEngine7

Microsoft.Build.Framework.IBuildEngine8

Microsoft.Build.Framework.IBuildEngine9

Implements

IBuildEngine IBuildEngine2 IBuildEngine3 IBuildEngine4

Properties

ColumnNumberOfTaskNode	Retrieves the line number of the task node within the project file that called it. (Inherited from IBuildEngine)
ContinueOnError	Returns true if the ContinueOnError flag was set to true for this particular task in the project file. (Inherited from IBuildEngine)
IsRunningMultipleNodes	This property allows a task to query whether or not the system is running in single process mode or multi process mode. Single process mode (IsRunningMultipleNodes = false) is where the engine is initialized with the number of cpus = 1 and the engine is not a child engine. The engine is in multi process mode (IsRunningMultipleNodes = true) when the engine is initialized with a number of cpus > 1 or the engine is a child engine. (Inherited from IBuildEngine2)
LineNumberOfTaskNode	Retrieves the line number of the task node within the project file that called it. (Inherited from IBuildEngine)
ProjectFileOfTaskNode	Returns the full path to the project file that contained the call to this task. (Inherited from IBuildEngine)

Methods

BuildProjectFile(String, String[], IDictionary, IDictionary)	This method allows tasks to initiate a build on a particular project file. If the build is successful, the outputs (if any) of the specified targets are returned. (Inherited from IBuildEngine)
BuildProjectFile(String, String[], IDictionary, IDictionary, String)	This method allows tasks to initiate a build on a particular project file. If the build is successful, the outputs (if any) of the specified targets are returned. (Inherited from IBuildEngine2)
BuildProjectFilesInParallel(String[], String[], IDictionary[], IDictionary[], String[], Boolean, Boolean)	This method allows tasks to initiate a build on a particular project file. If the build is successful, the outputs (if any) of the specified targets are returned. (Inherited from IBuildEngine2)
BuildProjectFilesInParallel(String[], String[], IDictionary[], IList<String>[], String[], Boolean)	This method allows tasks to initiate a build on a particular project file. If the build is successful, the outputs (if any) of the specified targets are returned. (Inherited from IBuildEngine3)
GetRegisteredTaskObject(Object, RegisteredTaskObjectLifetime)	Retrieves a previously registered task object stored with the specified key. (Inherited from IBuildEngine4)
LogCustomEvent(CustomBuildEventArgs)	Allows tasks to raise custom events to all registered loggers. The build engine may perform some filtering or pre-processing on the events, before dispatching them. (Inherited from IBuildEngine)
LogErrorEvent(BuildErrorEventArgs)	Allows tasks to raise error events to all registered loggers. The build engine may perform some filtering or pre-processing on the events, before dispatching them. (Inherited from IBuildEngine)
LogMessageEvent(BuildMessageEventArgs)	Allows tasks to raise message events to all registered loggers. The build engine may perform some filtering or pre-processing on the events, before dispatching them. (Inherited from IBuildEngine)
LogTelemetry(String, IDictionary<String,String>)	Logs telemetry.
LogWarningEvent(BuildWarningEventArgs)	Allows tasks to raise warning events to all registered loggers. The build engine may perform some filtering or pre-processing on the events, before dispatching them. (Inherited from IBuildEngine)
Reacquire()	Waits to reacquire control after yielding. (Inherited from IBuildEngine3)
RegisterTaskObject(Object, Object, RegisteredTaskObjectLifetime, Boolean)	Registers an object with the system that will be disposed of at some specified time in the future. (Inherited from IBuildEngine4)
UnregisterTaskObject(Object, RegisteredTaskObjectLifetime)	Unregisters a previously-registered task object. (Inherited from IBuildEngine4)
Yield()	Informs the system that this task has a long-running out-of-process component and other work can be done in the build while that work completes. (Inherited from IBuildEngine3)