ConsoleLogger Class

Definition

Namespace:

Microsoft.Build.Logging

Assembly:

Microsoft.Build.dll

Package:

Microsoft.Build v17.9.5

This class implements the default logger that outputs event data to the console (stdout). It is a facade: it creates, wraps and delegates to a kind of BaseConsoleLogger, either SerialConsoleLogger or ParallelConsoleLogger.

public ref class ConsoleLogger : Microsoft::Build::Framework::INodeLogger

public class ConsoleLogger : Microsoft.Build.Framework.INodeLogger

type ConsoleLogger = class
    interface INodeLogger
    interface ILogger

Public Class ConsoleLogger
Implements INodeLogger

Inheritance

Object

ConsoleLogger

Derived

Microsoft.Build.Logging.FileLogger

Implements

ILogger INodeLogger

Remarks

This class is not thread safe.

Constructors

ConsoleLogger()	Default constructor.
ConsoleLogger(LoggerVerbosity)	Create a logger instance with a specific verbosity. This logs to the default console.
ConsoleLogger(LoggerVerbosity, WriteHandler, ColorSetter, ColorResetter)	Initializes the logger, with alternate output handlers.

Properties

Parameters	A semi-colon delimited list of "key[=value]" parameter pairs.
ShowSummary	Suppresses the display of error and warnings summary.
SkipProjectStartedText	Suppresses the display of project headers. Project headers are displayed by default unless this property is set.
Verbosity	Gets or sets the level of detail to show in the event log.
WriteHandler	Provide access to the write hander delegate so that it can be redirected if necessary (e.g. to a file)

Methods

ApplyParameter(String, String)	Apply a parameter. NOTE: This method was public by accident in Whidbey, so it cannot be made internal now. It has no good reason for being public.
BuildFinishedHandler(Object, BuildFinishedEventArgs)	Handler for build finished events
BuildStartedHandler(Object, BuildStartedEventArgs)	Handler for build started events
CustomEventHandler(Object, CustomBuildEventArgs)	Prints a custom event
ErrorHandler(Object, BuildErrorEventArgs)	Prints an error event
Initialize(IEventSource)	Signs up the console logger for all build events.
Initialize(IEventSource, Int32)	Initializes the logger.
MessageHandler(Object, BuildMessageEventArgs)	Prints a message event
ProjectFinishedHandler(Object, ProjectFinishedEventArgs)	Handler for project finished events
ProjectStartedHandler(Object, ProjectStartedEventArgs)	Handler for project started events
Shutdown()	The console logger does not need to release any resources. This method does nothing.
TargetFinishedHandler(Object, TargetFinishedEventArgs)	Handler for target finished events
TargetStartedHandler(Object, TargetStartedEventArgs)	Handler for target started events
TaskFinishedHandler(Object, TaskFinishedEventArgs)	Handler for task finished events
TaskStartedHandler(Object, TaskStartedEventArgs)	Handler for task started events
WarningHandler(Object, BuildWarningEventArgs)	Prints a warning event