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

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

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.

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.

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.

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.

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

.NET Framework
Available since 3.5
Return to top
Show: