This topic has not yet been rated - Rate this topic

EventSchemaTraceListener Constructor (String, String, Int32, TraceLogRetentionOption, Int64, Int32)

.NET Framework 4

Initializes a new instance of the EventSchemaTraceListener class with the specified name and specified buffer size, using the specified file with the specified log retention policy, maximum size, and file count as the recipient of the debugging and tracing output.

Namespace: System.Diagnostics
Assembly: System.Core (in System.Core.dll)

Syntax

C++

Copy

public EventSchemaTraceListener(
	string fileName,
	string name,
	int bufferSize,
	TraceLogRetentionOption logRetentionOption,
	long maximumFileSize,
	int maximumNumberOfFiles
)

Parameters

fileName: Type: System.String
The path for the log file.

name: Type: System.String
The name of the listener.

bufferSize: Type: System.Int32
The size of the output buffer, in bytes.

logRetentionOption: Type: System.Diagnostics.TraceLogRetentionOption
One of the TraceLogRetentionOption values.

maximumFileSize: Type: System.Int64
The maximum file size, in bytes.

maximumNumberOfFiles: Type: System.Int32
The maximum number of output log files.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	maximumFileSize is less than bufferSize.
ArgumentOutOfRangeException	maximumFileSize is a negative number.
ArgumentOutOfRangeException	maximumNumberOfFiles is less than 1, and logRetentionOption is LimitedSequentialFiles.
ArgumentOutOfRangeException	maximumNumberOfFiles is less than 2, and logRetentionOption is LimitedCircularFiles.

Remarks

For performance considerations, bufferSize and maximumFileSize should be multiples of 1024 bytes. maximumFileSize is not an absolute value; it is a threshold that can be exceeded up to the size of the last message.

Examples

The following code example demonstrates how to use the EventSchemaTraceListener constructor. This code example is part of a larger example that is provided for the EventSchemaTraceListener class.

Copy


//ts.Listeners.Add(new EventSchemaTraceListener("TraceOutput.xml", "eventListener", 65536, TraceLogRetentionOption.LimitedCircularFiles, 20480000, 2));
ts.Listeners.Add(new EventSchemaTraceListener("TraceOutput.xml", "eventListener"));

Version Information

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

EventSchemaTraceListener Class

EventSchemaTraceListener Overload

System.Diagnostics Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ