DefaultTraceListener Класс

Определение

Предоставляет методы вывода по умолчанию и поведение для трассировки.Provides the default output methods and behavior for tracing.

public ref class DefaultTraceListener : System::Diagnostics::TraceListener
[System.Runtime.InteropServices.ComVisible(false)]
public class DefaultTraceListener : System.Diagnostics.TraceListener
type DefaultTraceListener = class
    inherit TraceListener
Public Class DefaultTraceListener
Inherits TraceListener
Наследование
DefaultTraceListener
Атрибуты

Примеры

В следующем примере кода вычисляется биномиальное коэффициенты, которые являются значениями, используемыми в вероятности и статистике.The following code example calculates binomial coefficients, which are values used in probability and statistics. В этом примере используется DefaultTraceListener для трассировки результатов и ошибок в журнале.This example uses a DefaultTraceListener to trace results and log errors. Он создает новый DefaultTraceListener, добавляет его в коллекцию Trace.Listeners и устанавливает свойство LogFileName в файл журнала, указанный в аргументах командной строки.It creates a new DefaultTraceListener, adds it to the Trace.Listeners collection, and sets the LogFileName property to the log file specified in the command-line arguments.

Если при обработке входного параметра обнаружена ошибка или если функция CalcBinomial создает исключение, то Fail метод регистрирует и выводит сообщение об ошибке.If an error is detected while processing the input parameter, or if the CalcBinomial function throws an exception, the Fail method logs and displays an error message. Если свойство AssertUiEnabled false, сообщение об ошибке также записывается в консоль.If the AssertUiEnabled property is false, the error message is also written to the console. После успешного вычисления результата методы Write(String) и WriteLine(String) записывают результаты в файл журнала.When the result is calculated successfully, the Write(String) and WriteLine(String) methods write the results to the log file.

Методы Fail, Writeи WriteLine приводят к тому, что данные трассировки будут записываться только в DefaultTraceListener.The Fail, Write, and WriteLine methods cause trace information to be written only to the DefaultTraceListener. Чтобы записать данные трассировки во все прослушиватели в коллекции Trace.Listeners, используйте методы Fail, Writeи WriteLine класса Trace.To write trace information to all listeners in the Trace.Listeners collection, use the Fail, Write, and WriteLine methods of the Trace class.

using System;
using System.Diagnostics;
using Microsoft.VisualBasic;

class Binomial
{

    // args(0) is the number of possibilities for binomial coefficients.
    // args(1) is the file specification for the trace log file.
    public static void Main(string[] args)
    {

        decimal possibilities;
        decimal iter;

        // Remove the original default trace listener.
        Trace.Listeners.RemoveAt(0);

        // Create and add a new default trace listener.
        DefaultTraceListener defaultListener;
        defaultListener = new DefaultTraceListener();
        Trace.Listeners.Add(defaultListener);

        // Assign the log file specification from the command line, if entered.
        if (args.Length>=2)
        {
            defaultListener.LogFileName = args[1];
        }

        // Validate the number of possibilities argument.
        if (args.Length>=1)

            // Verify that the argument is a number within the correct range.
        {
            try
            {
                const decimal MAX_POSSIBILITIES = 99;
                possibilities = Decimal.Parse(args[0]);
                if (possibilities<0||possibilities>MAX_POSSIBILITIES)
                {
                    throw new Exception(String.Format("The number of possibilities must " +
                        "be in the range 0..{0}.", MAX_POSSIBILITIES));
                }
            }
            catch(Exception ex)
            {
                string failMessage = String.Format("\"{0}\" " +
                    "is not a valid number of possibilities.", args[0]);
                defaultListener.Fail(failMessage, ex.Message);
                if (!defaultListener.AssertUiEnabled)
                {
                    Console.WriteLine(failMessage+ "\n" +ex.Message);
                }
                return;
            }
        }
        else
        {
            // Report that the required argument is not present.
            const string ENTER_PARAM = "Enter the number of " +
                      "possibilities as a command line argument.";
            defaultListener.Fail(ENTER_PARAM);
            if (!defaultListener.AssertUiEnabled)
            {
                Console.WriteLine(ENTER_PARAM);
            }
            return;
        }

        for(iter=0; iter<=possibilities; iter++)
        {
            decimal result;
            string binomial;

            // Compute the next binomial coefficient and handle all exceptions.
            try
            {
                result = CalcBinomial(possibilities, iter);
            }
            catch(Exception ex)
            {
                string failMessage = String.Format("An exception was raised when " +
                    "calculating Binomial( {0}, {1} ).", possibilities, iter);
                defaultListener.Fail(failMessage, ex.Message);
                if (!defaultListener.AssertUiEnabled)
                {
                    Console.WriteLine(failMessage+ "\n" +ex.Message);
                }
                return;
            }

            // Format the trace and console output.
            binomial = String.Format("Binomial( {0}, {1} ) = ", possibilities, iter);
            defaultListener.Write(binomial);
            defaultListener.WriteLine(result.ToString());
            Console.WriteLine("{0} {1}", binomial, result);
        }
    }

    public static decimal CalcBinomial(decimal possibilities, decimal outcomes)
    {

        // Calculate a binomial coefficient, and minimize the chance of overflow.
        decimal result = 1;
        decimal iter;
        for(iter=1; iter<=possibilities-outcomes; iter++)
        {
            result *= outcomes+iter;
            result /= iter;
        }
        return result;
    }
}
Imports System.Diagnostics

Module Binomial

    ' args(0) is the number of possibilities for binomial coefficients.
    ' args(1) is the file specification for the trace log file.
    Sub Main(ByVal args() As String)

        Dim possibilities As Decimal
        Dim iter As Decimal

        ' Remove the original default trace listener.
        Trace.Listeners.RemoveAt(0)

        ' Create and add a new default trace listener.
        Dim defaultListener As DefaultTraceListener
        defaultListener = New DefaultTraceListener
        Trace.Listeners.Add(defaultListener)

        ' Assign the log file specification from the command line, if entered.
        If args.Length >= 2 Then
            defaultListener.LogFileName = args(1)
        End If

        ' Validate the number of possibilities argument.
        If args.Length >= 1 Then

            ' Verify that the argument is a number within the correct range.
            Try
                Const MAX_POSSIBILITIES As Decimal = 99
                possibilities = Decimal.Parse(args(0))
                If possibilities < 0 Or possibilities > MAX_POSSIBILITIES Then
                    Throw New Exception( _
                        String.Format("The number of possibilities must " & _
                            "be in the range 0..{0}.", MAX_POSSIBILITIES))
                End If
            Catch ex As Exception
                Dim failMessage As String = String.Format("""{0}"" " & _
                    "is not a valid number of possibilities.", args(0))
                defaultListener.Fail(failMessage, ex.Message)
                If Not defaultListener.AssertUiEnabled Then
                    Console.WriteLine(failMessage & vbCrLf & ex.Message)
                End If
                Return
            End Try
        Else
            ' Report that the required argument is not present.
            Const ENTER_PARAM As String = "Enter the number of " & _
                "possibilities as a command line argument."
            defaultListener.Fail(ENTER_PARAM)
            If Not defaultListener.AssertUiEnabled Then
                Console.WriteLine(ENTER_PARAM)
            End If
            Return
        End If

        For iter = 0 To possibilities
            Dim result As Decimal
            Dim binomial As String

            ' Compute the next binomial coefficient and handle all exceptions.
            Try
                result = CalcBinomial(possibilities, iter)
            Catch ex As Exception
                Dim failMessage As String = String.Format( _
                        "An exception was raised when " & _
                        "calculating Binomial( {0}, {1} ).", _
                        possibilities, iter)
                defaultListener.Fail(failmessage, ex.Message)
                If Not defaultListener.AssertUiEnabled Then
                    Console.WriteLine(failMessage & vbCrLf & ex.Message)
                End If
                Return
            End Try

            ' Format the trace and console output.
            binomial = String.Format("Binomial( {0}, {1} ) = ", _
                            possibilities, iter)
            defaultListener.Write(binomial)
            defaultListener.WriteLine(result.ToString)
            Console.WriteLine("{0} {1}", binomial, result)
        Next
    End Sub

    Function CalcBinomial(ByVal possibilities As Decimal, _
                        ByVal outcomes As Decimal) As Decimal

        ' Calculate a binomial coefficient, and minimize the chance of overflow.
        Dim result As Decimal = 1
        Dim iter As Decimal
        For iter = 1 To possibilities - outcomes
            result *= outcomes + iter
            result /= iter
        Next
        Return result
    End Function
End Module

Комментарии

Экземпляр этого класса автоматически добавляется в коллекции Debug.Listeners и Trace.Listeners.An instance of this class is automatically added to the Debug.Listeners and Trace.Listeners collections. Явное добавление второй DefaultTraceListener вызывает дублирование сообщений в окне вывода отладчика и повторяющихся окнах сообщений для утверждений.Explicitly adding a second DefaultTraceListener causes duplicate messages in the debugger output window and duplicate message boxes for asserts.

По умолчанию методы Write и WriteLine выдают сообщение в функцию Win32 OutputDebugString и метод Debugger.Log.By default, the Write and WriteLine methods emit the message to the Win32 OutputDebugString function and to the Debugger.Log method.

По умолчанию метод Fail отображает окно сообщения, когда приложение выполняется в режиме пользовательского интерфейса. Он также выдает сообщение с помощью WriteLine.The Fail method, by default, displays a message box when the application is running in a user interface mode; it also emits the message using WriteLine.

Примечание

Отображение окна сообщения для вызовов методов Assert и Fail зависит от наличия DefaultTraceListener.The display of the message box for Assert and Fail method calls depends on the presence of the DefaultTraceListener. Если DefaultTraceListener не находится в коллекции Listeners, окно сообщения не отображается.If the DefaultTraceListener is not in the Listeners collection, the message box is not displayed. DefaultTraceListener можно удалить с помощью элемента<clear >, <удалить элемент >или путем вызова метода Clear в свойстве Listeners (System.Diagnostics.Trace.Listeners.Clear()).The DefaultTraceListener can be removed by the <clear> element, by the <remove> element, or by calling the Clear method on the Listeners property (System.Diagnostics.Trace.Listeners.Clear()).

Для использования прослушивателя трассировки необходимо включить трассировку или отладку.You must enable tracing or debugging to use a trace listener. Ниже приведен синтаксис, характерный для компилятора.The following syntax is compiler specific. Если вы используете компиляторы, отличные C# от или Visual Basic, обратитесь к документации по компилятору.If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler.

  • Чтобы включить отладку C#в, добавьте флаг /d:DEBUG в командную строку компилятора при компиляции кода или добавьте #define DEBUG в начало файла.To enable debugging in C#, add the /d:DEBUG flag to the compiler command line when you compile your code, or add #define DEBUG to the top of your file. В Visual Basic добавьте флаг /d:DEBUG=True в командную строку компилятора.In Visual Basic, add the /d:DEBUG=True flag to the compiler command line.

  • Чтобы включить трассировку C#в, добавьте флаг /d:TRACE в командную строку компилятора при компиляции кода или добавьте #define TRACE в начало файла.To enable tracing in C#, add the /d:TRACE flag to the compiler command line when you compile your code, or add #define TRACE to the top of your file. В Visual Basic добавьте флаг /d:TRACE=True в командную строку компилятора.In Visual Basic, add the /d:TRACE=True flag to the compiler command line.

Чтобы добавить прослушиватель трассировки, измените файл конфигурации, соответствующий имени приложения.To add a trace listener, edit the configuration file that corresponds to the name of your application. В этом файле можно добавить прослушиватель, задать его тип и задать его параметры, удалить прослушиватель или удалить все прослушиватели, заданные приложением ранее.Within this file, you can add a listener, set its type and set its parameters, remove a listener, or clear all the listeners previously set by the application. Файл конфигурации должен быть отформатирован так, как показано в следующем примере:The configuration file should be formatted similar to the following example:

<configuration>  
<system.diagnostics>  
  <trace autoflush="false" indentsize="4">  
    <listeners>  
      <remove name="Default" />  
      <add name="myListener"  type="System.Diagnostics.TextWriterTraceListener"    initializeData="c:\myListener.log" />  
    </listeners>  
  </trace>  
</system.diagnostics>  
</configuration>  

Конструкторы

DefaultTraceListener()

Инициализирует новый экземпляр класса DefaultTraceListener со значением "Default" в качестве значения его свойства Name.Initializes a new instance of the DefaultTraceListener class with "Default" as its Name property value.

Свойства

AssertUiEnabled

Получает или задает значение, указывающее, выполняется ли приложение в режиме пользовательского интерфейса.Gets or sets a value indicating whether the application is running in user-interface mode.

Attributes

Возвращает настраиваемые атрибуты прослушивателя трассировки, определенные в файле конфигурации приложения.Gets the custom trace listener attributes defined in the application configuration file.

(Унаследовано от TraceListener)
Filter

Получает или задает фильтр трассировки для прослушивателя трассировки.Gets or sets the trace filter for the trace listener.

(Унаследовано от TraceListener)
IndentLevel

Возвращает или задает уровень отступа.Gets or sets the indent level.

(Унаследовано от TraceListener)
IndentSize

Возвращает или задает число пробелов в отступе.Gets or sets the number of spaces in an indent.

(Унаследовано от TraceListener)
IsThreadSafe

Возвращает значение, указывающее, является ли прослушиватель трассировки потокобезопасным.Gets a value indicating whether the trace listener is thread safe.

(Унаследовано от TraceListener)
LogFileName

Получает или задает имя файла журнала, в который осуществляется запись сообщений при трассировке или отладке.Gets or sets the name of a log file to write trace or debug messages to.

Name

Возвращает или задает имя данного TraceListener.Gets or sets a name for this TraceListener.

(Унаследовано от TraceListener)
NeedIndent

Возвращает или задает значение, указывающее, нужен ли отступ в выходных данных.Gets or sets a value indicating whether to indent the output.

(Унаследовано от TraceListener)
TraceOutputOptions

Возвращает или задает параметры выходных данных трассировки.Gets or sets the trace output options.

(Унаследовано от TraceListener)

Методы

Close()

Если переопределено в производном классе, закрывает выходной поток, который, таким образом, больше не принимает выходные данные трассировки и отладки.When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output.

(Унаследовано от TraceListener)
CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
Dispose()

Освобождает все ресурсы, занятые TraceListener.Releases all resources used by the TraceListener.

(Унаследовано от TraceListener)
Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые TraceListener, и дополнительно освобождает управляемые ресурсы.Releases the unmanaged resources used by the TraceListener and optionally releases the managed resources.

(Унаследовано от TraceListener)
Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Fail(String)

Выдает или отображает сообщение и запись изменений стека для утверждения, в котором всегда возникает ошибка.Emits or displays a message and a stack trace for an assertion that always fails.

Fail(String, String)

Выдает или отображает подробные сообщения и запись изменений стека для утверждения, в котором возникает ошибка.Emits or displays detailed messages and a stack trace for an assertion that always fails.

Flush()

Если переопределено в производном классе, очищает выходной буфер.When overridden in a derived class, flushes the output buffer.

(Унаследовано от TraceListener)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetSupportedAttributes()

Возвращает настраиваемые атрибуты, поддерживаемые прослушивателем трассировки.Gets the custom attributes supported by the trace listener.

(Унаследовано от TraceListener)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)

Записывает сведения трассировки, объект данных и сведения о событиях в специальные выходные данные прослушивателя.Writes trace information, a data object and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])

Записывает сведения трассировки, массив объектов данных и сведения о событии в специальные выходные данные прослушивателя.Writes trace information, an array of data objects and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32)

Записывает сведения трассировки и сведения о событиях в специальные выходные данные прослушивателя.Writes trace and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)

Записывает сведения трассировки, сообщение и сведения о событиях в специальные выходные данные прослушивателя.Writes trace information, a message, and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])

Записывает сведения трассировки, форматированный массив объектов данных и сведения о событиях в специальные выходные данные прослушивателя.Writes trace information, a formatted array of objects and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceTransfer(TraceEventCache, String, Int32, String, Guid)

Записывает сведения трассировки, сообщение, идентификатор сопутствующего действия и сведения о событиях в специальные выходные данные прослушивателя.Writes trace information, a message, a related activity identity and event information to the listener specific output.

(Унаследовано от TraceListener)
Write(Object)

Записывает значение метода ToString() объекта в прослушиватель, создаваемый при реализации класса TraceListener.Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(Унаследовано от TraceListener)
Write(Object, String)

Записывает имя категории и значение метода ToString() объекта в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(Унаследовано от TraceListener)
Write(String)

Записывает вывод в функцию OutputDebugString и метод Log(Int32, String, String).Writes the output to the OutputDebugString function and to the Log(Int32, String, String) method.

Write(String, String)

Записывает имя категории и сообщение в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and a message to the listener you create when you implement the TraceListener class.

(Унаследовано от TraceListener)
WriteIndent()

Записывает отступ в прослушиватель, создаваемый при реализации этого класса, и восстанавливает свойству NeedIndent значение false.Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to false.

(Унаследовано от TraceListener)
WriteLine(Object)

Записывает значение метода ToString() объекта, заканчивающееся знаком ограничителя строки, в прослушиватель, создаваемый при реализации класса TraceListener.Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Унаследовано от TraceListener)
WriteLine(Object, String)

Записывает имя категории и значение метода ToString() объекта, заканчивающееся знаком ограничителя строки, в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and the value of the object's ToString() method to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Унаследовано от TraceListener)
WriteLine(String)

Записывает вывод в функцию OutputDebugString и метод Log(Int32, String, String), затем происходит возврат каретки и перевод строки (\r\n).Writes the output to the OutputDebugString function and to the Log(Int32, String, String) method, followed by a carriage return and line feed (\r\n).

WriteLine(String, String)

Записывает имя категории и сообщение, заканчивающееся знаком ограничителя строки, в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and a message to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Унаследовано от TraceListener)

Применяется к

Потокобезопасность

Этот класс является потокобезопасным.This class is thread safe.

Дополнительно