TerminalLogger Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A logger which updates the console output "live" during the build.
public ref class TerminalLogger sealed : Microsoft::Build::Framework::INodeLogger
public sealed class TerminalLogger : Microsoft.Build.Framework.INodeLogger
type TerminalLogger = class
interface INodeLogger
interface ILogger
Public NotInheritable Class TerminalLogger
Implements INodeLogger
- Inheritance
-
TerminalLogger
- Implements
Remarks
Uses ANSI/VT100 control codes to erase and overwrite lines as the build is progressing.
Properties
Parameters |
This property holds the user-specified parameters to the logger. If parameters are not provided, a logger should revert to defaults. If a logger does not take parameters, it can ignore this property. |
Verbosity |
The verbosity level directs the amount of detail that appears in a logger's event log. Though this is only a recommendation based on user preferences, and a logger is free to choose the exact events it logs, it is still important that the guidelines for each level be followed, for a good user experience. |
Methods
CreateTerminalOrConsoleLogger(String[]) |
Creates a Terminal logger if possible, or a Console logger. |
Initialize(IEventSource, Int32) |
Initializes the current INodeLogger instance. |
Initialize(IEventSource) |
Called by the build engine to allow loggers to subscribe to the events they desire. |
ParseParameters() |
Parses out the logger parameters from the Parameters string. |
Shutdown() |
Called by the build engine to allow loggers to release any resources they may have allocated at initialization time, or during the build. |