NLog - Documentation

Last updated: 2006-09-18

This website is based on NLog v1.0. Click here to view the documentation for other versions.

OutputDebugString Target

Outputs logging messages through the OutputDebugString() Win32 API.

Assembly	Class	.NET Framework			.NET CF		Mono on Windows		Mono on Unix
Assembly	Class	1.0	1.1	2.0	1.0	2.0	1.0	2.0	1.0	2.0
NLog.dll	NLog.Win32.Targets.OutputDebugStringTarget

Parameters (blue fields are required):

Name Type Description

layout

string ${}

The text to be rendered.

Default value is: ${longdate}|${level:uppercase=true}|${logger}|${message}.

name

string

The name of the target.

Example:

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

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 
  <targets> 
    <target name="n" xsi:type="OutputDebugString" layout="${message}"/> 
  </targets> 
  <rules> 
    <logger name="*" minlevel="Debug" writeTo="n"/> 
  </rules> 
</nlog>

This assumes just one target and a single rule. More configuration options are described here.

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

using System; 
 
using NLog; 
using NLog.Targets; 
using NLog.Win32.Targets; 
 
class Example 
{ 
    static void Main(string[] args) 
    { 
        OutputDebugStringTarget target = new OutputDebugStringTarget(); 
        target.Layout = "${message}"; 
 
        NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Debug); 
 
        Logger logger = LogManager.GetLogger("Example"); 
        logger.Debug("log message"); 
    } 
}

Back to the target list.