This documentation is archived and is not being maintained.

FileLogger Class

A specialization of the ConsoleLogger that logs to a file instead of the console.

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

public class FileLogger : ConsoleLogger

The FileLogger type exposes the following members.

Public methodFileLoggerCreates a file logger.

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

Public methodApplyParameterApplies a parameter to the logger. (Inherited from ConsoleLogger.)
Public methodBuildFinishedHandlerCalled when the build is finished. (Inherited from ConsoleLogger.)
Public methodBuildStartedHandlerCalled when the build is started. (Inherited from ConsoleLogger.)
Public methodCustomEventHandlerCalled to log a custom event. (Inherited from ConsoleLogger.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodErrorHandlerCalled to log an error event. (Inherited from ConsoleLogger.)
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 file logger for the given build events. (Overrides ConsoleLogger.Initialize(IEventSource).)
Public methodInitialize(IEventSource, Int32)Initializes a file logger in a multiprocessor environment. (Overrides ConsoleLogger.Initialize(IEventSource, Int32).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMessageHandlerCalled to log a message event. (Inherited from ConsoleLogger.)
Public methodProjectFinishedHandlerCalled to log a project finished event. (Inherited from ConsoleLogger.)
Public methodProjectStartedHandlerCalled to log a project started event. (Inherited from ConsoleLogger.)
Public methodShutdownCalled when the build is finished. (Overrides ConsoleLogger.Shutdown().)
Public methodTargetFinishedHandlerCalled to log a target finished event. (Inherited from ConsoleLogger.)
Public methodTargetStartedHandlerCalled to log a target started event. (Inherited from ConsoleLogger.)
Public methodTaskFinishedHandlerCalled to log a task finished event. (Inherited from ConsoleLogger.)
Public methodTaskStartedHandlerCalled to log a task started event. (Inherited from ConsoleLogger.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWarningHandlerCalled to log a warning event. (Inherited from ConsoleLogger.)

The output in terms of what is written and how it looks is identical. For example you can log verbosely to a file using the FileLogger while simultaneously logging only high priority events to the console using a ConsoleLogger.

.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.