ConsoleLogger Class

 

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

Namespace:   Microsoft.Build.Logging
Assembly:  Microsoft.Build (in Microsoft.Build.dll)

System.Object
  Microsoft.Build.Logging.ConsoleLogger
    Microsoft.Build.Logging.FileLogger

public class ConsoleLogger : INodeLogger, ILogger

NameDescription
System_CAPS_pubmethodConsoleLogger()

Creates a default logger.

System_CAPS_pubmethodConsoleLogger(LoggerVerbosity)

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

System_CAPS_pubmethodConsoleLogger(LoggerVerbosity, WriteHandler, ColorSetter, ColorResetter)

Initializes the logger with alternate output handlers.

NameDescription
System_CAPS_pubpropertyParameters

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

System_CAPS_pubpropertyShowSummary

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

System_CAPS_pubpropertySkipProjectStartedText

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

System_CAPS_pubpropertyVerbosity

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

System_CAPS_protpropertyWriteHandler

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

NameDescription
System_CAPS_pubmethodApplyParameter(String, String)

Applies a parameter to the logger.

System_CAPS_pubmethodBuildFinishedHandler(Object, BuildFinishedEventArgs)

Called when the build is finished.

System_CAPS_pubmethodBuildStartedHandler(Object, BuildStartedEventArgs)

Called when the build is started.

System_CAPS_pubmethodCustomEventHandler(Object, CustomBuildEventArgs)

Called to log a custom event.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodErrorHandler(Object, BuildErrorEventArgs)

Called to log an error event.

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitialize(IEventSource)

Signs up the console logger for the given build event.

System_CAPS_pubmethodInitialize(IEventSource, Int32)

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

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodMessageHandler(Object, BuildMessageEventArgs)

Called to log a message event.

System_CAPS_pubmethodProjectFinishedHandler(Object, ProjectFinishedEventArgs)

Called to log a project finished event.

System_CAPS_pubmethodProjectStartedHandler(Object, ProjectStartedEventArgs)

Called to log a project started event.

System_CAPS_pubmethodShutdown()

Called when the build is finished.

System_CAPS_pubmethodTargetFinishedHandler(Object, TargetFinishedEventArgs)

Called to log a target finished event.

System_CAPS_pubmethodTargetStartedHandler(Object, TargetStartedEventArgs)

Called to log a target started event.

System_CAPS_pubmethodTaskFinishedHandler(Object, TaskFinishedEventArgs)

Called to log a task finished event.

System_CAPS_pubmethodTaskStartedHandler(Object, TaskStartedEventArgs)

Called to log a task started event.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWarningHandler(Object, BuildWarningEventArgs)

Called to log a warning event.

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

This class is not thread safe.

.NET Framework
Available since 4.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: