Click or drag to resize

NullTarget Class

Discards log messages. Used mainly for debugging and benchmarking.
Inheritance Hierarchy
SystemObject
  NLog.TargetsTarget
    NLog.TargetsTargetWithLayout
      NLog.TargetsNullTarget

Namespace:  NLog.Targets
Assembly:  NLog (in NLog.dll) Version: 5.3.4+73d83d3161d31288ca5c554cc50d27b6bed5f28b
Syntax
public sealed class NullTarget : TargetWithLayout

The NullTarget type exposes the following members.

Constructors
  NameDescription
Public methodNullTarget
Initializes a new instance of the NullTarget class.
Public methodNullTarget(String)
Initializes a new instance of the NullTarget class.
Top
Properties
  NameDescription
Public propertyFormatMessage
Gets or sets a value indicating whether to perform layout calculation.
Public propertyLayout
Gets or sets the layout used to format log messages.
(Inherited from TargetWithLayout.)
Public propertyName
Gets or sets the name of the target.
(Inherited from Target.)
Top
Methods
  NameDescription
Public methodDispose
Closes the target.
(Inherited from Target.)
Public methodFlush
Flush any pending log messages (in case of asynchronous targets).
(Inherited from Target.)
Public methodPrecalculateVolatileLayouts
Calls the Precalculate(LogEventInfo) on each volatile layout used by this target. This method won't prerender if all layouts in this target are thread-agnostic.
(Inherited from Target.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Target.)
Public methodWriteAsyncLogEvent
Writes the log to the target.
(Inherited from Target.)
Public methodWriteAsyncLogEvents(AsyncLogEventInfo)
Writes the array of log events.
(Inherited from Target.)
Public methodWriteAsyncLogEvents(IListAsyncLogEventInfo)
Writes the array of log events.
(Inherited from Target.)
Top
Remarks
Examples

To set up the target in the configuration file, use the following syntax:

XML
 1<?xml version="1.0" ?>
 2<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
 3      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 4    <targets>
 5        <target name="n" xsi:type="Null" layout="${message}" formatMessage="true" />
 6    </targets>
 7
 8    <rules>
 9        <logger name="*" minlevel="Debug" writeTo="n" />
10    </rules>
11</nlog>

To set up the log target programmatically use code like this:

C#
 1using System;
 2
 3using NLog;
 4using NLog.Targets;
 5
 6class Example
 7{
 8    static void Main(string[] args)
 9    {
10        NullTarget target = new NullTarget();
11        target.Layout = "${message}";
12        target.FormatMessage = true;
13
14        NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Debug);
15
16        Logger logger = LogManager.GetLogger("Example");
17        logger.Debug("log message");
18    }
19}
See Also