This documentation is archived and is not being maintained.

ConsoleLogger Class

Implements the standard console logger that outputs event data to the console window during a build.


Namespace:  Microsoft.Build.BuildEngine
Assembly:  Microsoft.Build.Engine (in Microsoft.Build.Engine.dll)

public class ConsoleLogger : INodeLogger, 

The ConsoleLogger type exposes the following members.

Public methodConsoleLogger()Initializes a new instance of the ConsoleLogger class.
Public methodConsoleLogger(LoggerVerbosity)Initializes a new instance of the ConsoleLogger class with the specified LoggerVerbosity.
Public methodConsoleLogger(LoggerVerbosity, WriteHandler, ColorSetter, ColorResetter)Initializes a new instance of the ConsoleLogger class with the specified LoggerVerbosity, ColorSetter, and ColorResetter values.

Public propertyParametersGets or sets the parameters passed to the ConsoleLogger.
Public propertyShowSummaryGets or sets a value indicating whether the logger will display a summary of errors and warnings.
Public propertySkipProjectStartedTextGets or sets a value indicating whether the logger will display messages when new projects are started during the build.
Public propertyVerbosityGets or sets the LoggerVerbosity level of the logger.
Protected propertyWriteHandlerGets or sets to the WriteHandler delegate for the ConsoleLogger.

Public methodApplyParameterAdds the specified parameter name and value to the logger.
Public methodBuildFinishedHandlerHandles the BuildFinished event.
Public methodBuildStartedHandlerHandles the BuildStarted event.
Public methodCustomEventHandlerHandles the CustomEventRaised event.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodErrorHandlerHandles the ErrorRaised 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)Registers the logger for the specified events.
Public methodInitialize(IEventSource, Int32)Registers the logger for the specified events.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMessageHandlerHandles the MessageRaised event.
Public methodProjectFinishedHandlerHandles the ProjectFinished event.
Public methodProjectStartedHandlerHandles the ProjectStarted event.
Public methodShutdownStops the logger and releases all resources.
Public methodTargetFinishedHandlerHandles the TargetFinished event.
Public methodTargetStartedHandlerHandles the TargetStarted event.
Public methodTaskFinishedHandlerHandles the TaskFinished event.
Public methodTaskStartedHandlerHandles the TaskStarted event.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWarningHandlerHandles the WarningRaised event.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.