ConsoleLogger ConsoleLogger ConsoleLogger ConsoleLogger Class

Definition

Represents the default logger that outputs event data to the console (stdout).

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
ConsoleLoggerConsoleLoggerConsoleLoggerConsoleLogger
Derived
Implements

Remarks

This class creates, wraps, and delegates to a BaseConsoleLogger, either SerialConsoleLogger or ParallelConsoleLogger.

This class is not thread safe.

Constructors

ConsoleLogger() ConsoleLogger() ConsoleLogger() ConsoleLogger()

Creates a default logger.

ConsoleLogger(LoggerVerbosity) ConsoleLogger(LoggerVerbosity) ConsoleLogger(LoggerVerbosity) ConsoleLogger(LoggerVerbosity)

Creates a logger instance with the given verbosity that logs to the default console.

ConsoleLogger(LoggerVerbosity, WriteHandler, ColorSetter, ColorResetter) ConsoleLogger(LoggerVerbosity, WriteHandler, ColorSetter, ColorResetter) ConsoleLogger(LoggerVerbosity, WriteHandler, ColorSetter, ColorResetter) ConsoleLogger(LoggerVerbosity, WriteHandler, ColorSetter, ColorResetter)

Initializes the logger with alternate output handlers.

Properties

Parameters Parameters Parameters Parameters

Gets or sets a semicolon-delimited list of parameter key-value pairs.

ShowSummary ShowSummary ShowSummary ShowSummary

Gets or sets a switch that determines whether to suppress the display of errors and the warnings summary.

SkipProjectStartedText SkipProjectStartedText SkipProjectStartedText SkipProjectStartedText

Gets or sets a switch that determines whether to suppress the display of project headers.

Verbosity Verbosity Verbosity Verbosity

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

WriteHandler WriteHandler WriteHandler WriteHandler

Provides access to the write handler delegate so that it can be redirected if necessary (e.g. to a file).

Methods

ApplyParameter(String, String) ApplyParameter(String, String) ApplyParameter(String, String) ApplyParameter(String, String)

Applies a parameter to the logger.

BuildFinishedHandler(Object, BuildFinishedEventArgs) BuildFinishedHandler(Object, BuildFinishedEventArgs) BuildFinishedHandler(Object, BuildFinishedEventArgs) BuildFinishedHandler(Object, BuildFinishedEventArgs)

Called when the build is finished.

BuildStartedHandler(Object, BuildStartedEventArgs) BuildStartedHandler(Object, BuildStartedEventArgs) BuildStartedHandler(Object, BuildStartedEventArgs) BuildStartedHandler(Object, BuildStartedEventArgs)

Called when the build is started.

CustomEventHandler(Object, CustomBuildEventArgs) CustomEventHandler(Object, CustomBuildEventArgs) CustomEventHandler(Object, CustomBuildEventArgs) CustomEventHandler(Object, CustomBuildEventArgs)

Called to log a custom event.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
ErrorHandler(Object, BuildErrorEventArgs) ErrorHandler(Object, BuildErrorEventArgs) ErrorHandler(Object, BuildErrorEventArgs) ErrorHandler(Object, BuildErrorEventArgs)

Called to log an error event.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
Initialize(IEventSource) Initialize(IEventSource) Initialize(IEventSource) Initialize(IEventSource)

Signs up the console logger for the given build event.

Initialize(IEventSource, Int32) Initialize(IEventSource, Int32) Initialize(IEventSource, Int32) Initialize(IEventSource, Int32)

Initializes the logger with the given event source and node count.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MessageHandler(Object, BuildMessageEventArgs) MessageHandler(Object, BuildMessageEventArgs) MessageHandler(Object, BuildMessageEventArgs) MessageHandler(Object, BuildMessageEventArgs)

Called to log a message event.

ProjectFinishedHandler(Object, ProjectFinishedEventArgs) ProjectFinishedHandler(Object, ProjectFinishedEventArgs) ProjectFinishedHandler(Object, ProjectFinishedEventArgs) ProjectFinishedHandler(Object, ProjectFinishedEventArgs)

Called to log a project finished event.

ProjectStartedHandler(Object, ProjectStartedEventArgs) ProjectStartedHandler(Object, ProjectStartedEventArgs) ProjectStartedHandler(Object, ProjectStartedEventArgs) ProjectStartedHandler(Object, ProjectStartedEventArgs)

Called to log a project started event.

Shutdown() Shutdown() Shutdown() Shutdown()

Called when the build is finished.

TargetFinishedHandler(Object, TargetFinishedEventArgs) TargetFinishedHandler(Object, TargetFinishedEventArgs) TargetFinishedHandler(Object, TargetFinishedEventArgs) TargetFinishedHandler(Object, TargetFinishedEventArgs)

Called to log a target finished event.

TargetStartedHandler(Object, TargetStartedEventArgs) TargetStartedHandler(Object, TargetStartedEventArgs) TargetStartedHandler(Object, TargetStartedEventArgs) TargetStartedHandler(Object, TargetStartedEventArgs)

Called to log a target started event.

TaskFinishedHandler(Object, TaskFinishedEventArgs) TaskFinishedHandler(Object, TaskFinishedEventArgs) TaskFinishedHandler(Object, TaskFinishedEventArgs) TaskFinishedHandler(Object, TaskFinishedEventArgs)

Called to log a task finished event.

TaskStartedHandler(Object, TaskStartedEventArgs) TaskStartedHandler(Object, TaskStartedEventArgs) TaskStartedHandler(Object, TaskStartedEventArgs) TaskStartedHandler(Object, TaskStartedEventArgs)

Called to log a task started event.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
WarningHandler(Object, BuildWarningEventArgs) WarningHandler(Object, BuildWarningEventArgs) WarningHandler(Object, BuildWarningEventArgs) WarningHandler(Object, BuildWarningEventArgs)

Called to log a warning event.

Applies to