MSBuildFileLogger Class

Summary

Contains settings for specifying a MSBuild file logger.
Namespace
Cake.Common.Tools.MSBuild
Base Types
  • object
graph BT Type-->Base0["object"] Type["MSBuildFileLogger"] class Type type-node

Syntax

public class MSBuildFileLogger

Constructors

Name Summary
MSBuildFileLogger() Initializes a new instance of the MSBuildFileLogger class.

Properties

Name Value Summary
AppendToLogFile bool
Gets or sets a value indicating whether the build log is appended to the log file or overwrites it. When true, the build log is appended to the log file.
Encoding string
Gets or sets Specifies the encoding for the file (for example, UTF-8, Unicode, or ASCII).
HideVerboseItemAndPropertyList bool
Gets or sets a value indicating whether NoItemAndPropertyList will be set to Don't show the list of items and properties that would appear at the start of each project build if the verbosity level is set to diagnostic.
LogFile FilePath
Gets or sets LogFile. The path to the log file into which the build log is written. An empty string will use msbuild.log.
MSBuildFileLoggerOutput MSBuildFileLoggerOutput
Gets or sets show ErrorsOnly, WarningsOnly, or All.
PerformanceSummaryEnabled bool
Gets or sets a value indicating whether PerformanceSummary will Show the time that’s spent in tasks, targets, and projects.
ShowCommandLine bool
Gets or sets a value indicating whether ShowCommandLine. Show TaskCommandLineEvent messages.
ShowEventId bool
Gets or sets a value indicating whether ShowEventId. Show the event ID for each started event, finished event, and message.
ShowTimestamp bool
Gets or sets a value indicating whether ShowTimestamp. Show the timestamp as a prefix to any message.
SummaryDisabled bool
Gets or sets a value indicating whether Summary will Show the error and warning summary at the end.
Verbosity Verbosity?
Gets or sets Verbosity. Override the /verbosity setting for this logger. Specify the following verbosity levels: q[uiet], m[inimal], n[ormal], v[erbose] (detailed), and diag[nostic].

Methods

Name Value Summary
GetParameters(ICakeEnvironment) string
Process the file logger config and return parameters as a string.

Extension Methods

Name Value Summary
Dump<MSBuildFileLogger>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<MSBuildFileLogger>(MSBuildFileLogger[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MSBuildFileLogger>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<MSBuildFileLogger>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<MSBuildFileLogger>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MSBuildFileLogger>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin