Engine.RegisterDistributedLogger(ILogger, LoggerDescription) Method

Definition

Namespace:

Microsoft.Build.BuildEngine

Assembly:

Microsoft.Build.Engine.dll

Package:

Microsoft.Build.Engine v17.11.4

Source:

Engine.cs

Called to register distributed loggers with the engine. This method is not thread safe. All loggers should registered prior to starting the build in order to guarantee uniform behavior

public:
 void RegisterDistributedLogger(Microsoft::Build::Framework::ILogger ^ centralLogger, Microsoft::Build::BuildEngine::LoggerDescription ^ forwardingLogger);

public void RegisterDistributedLogger (Microsoft.Build.Framework.ILogger centralLogger, Microsoft.Build.BuildEngine.LoggerDescription forwardingLogger);

member this.RegisterDistributedLogger : Microsoft.Build.Framework.ILogger * Microsoft.Build.BuildEngine.LoggerDescription -> unit

Public Sub RegisterDistributedLogger (centralLogger As ILogger, forwardingLogger As LoggerDescription)

Parameters

centralLogger

ILogger

An ILogger that represents the central logger.

forwardingLogger

LoggerDescription

A LoggerDescription that represents the forwarding logger.

Exceptions

LoggerException

Logger indicating it failed in a controlled way

InternalLoggerException

Logger threw arbitrary exception

Remarks

This method is not thread-safe. To ensure uniform behavior, all loggers should register before the build is started. For more information, see Write multi-processor-aware loggers.