This documentation is archived and is not being maintained.

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)

public class ConsoleLogger : INodeLogger, 

The ConsoleLogger type exposes the following members.

Public methodConsoleLogger()Creates a default logger.
Public methodConsoleLogger(LoggerVerbosity)Creates a logger instance with the given verbosity that logs to the default console.
Public methodConsoleLogger(LoggerVerbosity, WriteHandler, ColorSetter, ColorResetter)Initializes the logger with alternate output handlers.

Public propertyParametersGets or sets a semicolon-delimited list of parameter key-value pairs.
Public propertyShowSummaryGets or sets a switch that determines whether to suppress the display of errors and the warnings summary.
Public propertySkipProjectStartedTextGets or sets a switch that determines whether to suppress the display of project headers.
Public propertyVerbosityGets or sets the level of detail to show in the event log.
Protected propertyWriteHandlerProvides access to the write handler delegate so that it can be redirected if necessary (e.g. to a file).

Public methodApplyParameterApplies a parameter to the logger.
Public methodBuildFinishedHandlerCalled when the build is finished.
Public methodBuildStartedHandlerCalled when the build is started.
Public methodCustomEventHandlerCalled to log a custom event.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodErrorHandlerCalled to log an error event.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitialize(IEventSource)Signs up the console logger for the given build event.
Public methodInitialize(IEventSource, Int32)Initializes the logger with the given event source and node count.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMessageHandlerCalled to log a message event.
Public methodProjectFinishedHandlerCalled to log a project finished event.
Public methodProjectStartedHandlerCalled to log a project started event.
Public methodShutdownCalled when the build is finished.
Public methodTargetFinishedHandlerCalled to log a target finished event.
Public methodTargetStartedHandlerCalled to log a target started event.
Public methodTaskFinishedHandlerCalled to log a task finished event.
Public methodTaskStartedHandlerCalled to log a task started event.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWarningHandlerCalled 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

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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