Прочитать на английском

Поделиться через


Debug.WriteIf Метод

Определение

Записывает сведения об отладке в прослушиватели трассировки в коллекции Listeners, если условие true.

Перегрузки

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler)

Если conditiontrue, записывает имя категории и сообщение в прослушиватели трассировки в коллекции Listeners.

WriteIf(Boolean, Object)

Записывает значение метода ToString() объекта в прослушиватели трассировки в коллекции Listeners, если условие true.

WriteIf(Boolean, String)

Записывает сообщение в прослушиватели трассировки в коллекции Listeners, если условие true.

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler, String)

Записывает имя категории и сообщение в прослушиватели трассировки в коллекции Listeners, если указанное условие true.

WriteIf(Boolean, Object, String)

Записывает имя категории и значение метода ToString() объекта в прослушиватели трассировки в коллекции Listeners, если условие true.

WriteIf(Boolean, String, String)

Записывает имя категории и сообщение в прослушиватели трассировки в коллекции Listeners, если условие true.

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler)

Исходный код:
Debug.cs
Исходный код:
Debug.cs
Исходный код:
Debug.cs

Если conditiontrue, записывает имя категории и сообщение в прослушиватели трассировки в коллекции Listeners.

C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message);

Параметры

condition
Boolean

Условное выражение для вычисления. Если условие true, значение записывается в прослушиватели трассировки в коллекции.

message
Debug.WriteIfInterpolatedStringHandler

Сообщение для записи, если conditiontrue.

Атрибуты

Комментарии

Эта перегрузка была введена в .NET 6 для повышения производительности. В сравнении с перегрузками, которые принимают параметр String, эта перегрузка оценивает только элементы интерполированного форматирования строк, если это сообщение необходимо.

По умолчанию выходные данные записываются в экземпляр DefaultTraceListener.

Используйте параметр category для группировки выходных сообщений.

Этот метод вызывает метод Write прослушивателя трассировки.

См. также раздел

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

.NET 9 и другие версии
Продукт Версии
.NET 6, 7, 8, 9

WriteIf(Boolean, Object)

Исходный код:
Debug.cs
Исходный код:
Debug.cs
Исходный код:
Debug.cs

Записывает значение метода ToString() объекта в прослушиватели трассировки в коллекции Listeners, если условие true.

C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, object value);
C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, object? value);

Параметры

condition
Boolean

Условное выражение для вычисления. Если условие true, значение записывается в прослушиватели трассировки в коллекции.

value
Object

Объект, имя которого отправляется в Listeners.

Атрибуты

Примеры

В следующем примере создается TraceSwitch с именем generalSwitch. Этот параметр задается за пределами примера кода.

Если для параметра задано значение TraceLevelError или более поздней версии, в примере выводится имя параметра значения в Listeners. Сведения о добавлении прослушивателя в коллекцию Listeners см. в классе TraceListenerCollection.

Затем, если для TraceLevel задано значение Verbose, в примере выводится сообщение в той же строке, что и первое сообщение. Терминатор строки следует второму сообщению.

C#
// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(Object myObject)
{
    // Write the message if the TraceSwitch level is set to Error or higher.
    Debug.WriteIf(generalSwitch.TraceError, myObject);

    // Write a second message if the TraceSwitch level is set to Verbose.
    Debug.WriteLineIf(generalSwitch.TraceVerbose, " is not a valid value for this method.");
}

Комментарии

По умолчанию выходные данные записываются в экземпляр DefaultTraceListener.

Этот метод вызывает метод Write прослушивателя трассировки.

Примечания для тех, кто наследует этот метод

Вы можете свести к минимуму производительность инструментирования приложения с помощью инструкций If...Then вместо использования WriteIf(Boolean, String) инструкций. В следующих двух примерах кода отправляется одно и то же сообщение отладки. Однако первый пример гораздо быстрее при отключении трассировки, так как если mySwitch.TraceError оценивается false, не вызывайте Write(String). Второй пример всегда вызывает WriteIf(Boolean, String), даже если mySwitch.TraceErrorfalse и выходные данные трассировки не создаются. Это может привести к ненужным выполнению произвольно сложного кода.

Первый пример:

C#
if(mySwitch.TraceError)
    Debug.Write("aNumber = " + aNumber + " out of range");

Второй пример:

C#
Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

См. также раздел

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

.NET 9 и другие версии
Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

WriteIf(Boolean, String)

Исходный код:
Debug.cs
Исходный код:
Debug.cs
Исходный код:
Debug.cs

Записывает сообщение в прослушиватели трассировки в коллекции Listeners, если условие true.

C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, string message);
C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, string? message);

Параметры

condition
Boolean

Условное выражение для вычисления. Если условие true, сообщение записывается в прослушиватели трассировки в коллекции.

message
String

Сообщение для записи.

Атрибуты

Примеры

В следующем примере создается TraceSwitch с именем generalSwitch. Этот параметр задается за пределами примера кода.

Если для параметра задано значение TraceLevelError или более поздней версии, в примере выводится первое сообщение об ошибке в Listeners. Сведения о добавлении прослушивателя в коллекцию Listeners см. в классе TraceListenerCollection.

Затем, если для TraceLevel задано значение Verbose, в примере выводится второе сообщение об ошибке в той же строке, что и первое сообщение. Терминатор строки следует второму сообщению.

C#
// Class-level declaration.
// Create a TraceSwitch.
TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static void MyErrorMethod()
{
    // Write the message if the TraceSwitch level is set to Error or higher.
    Debug.WriteIf(generalSwitch.TraceError, "My error message. ");

    // Write a second message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, "My second error message.");
}

Комментарии

По умолчанию выходные данные записываются в экземпляр DefaultTraceListener.

Этот метод вызывает метод Write прослушивателя трассировки.

Примечания для тех, кто наследует этот метод

Вы можете свести к минимуму производительность инструментирования приложения с помощью инструкций If...Then вместо использования WriteIf(Boolean, String) инструкций. В следующих двух примерах кода отправляется одно и то же сообщение отладки. Однако первый пример гораздо быстрее при отключении трассировки, так как если mySwitch.TraceError оценивается false, не вызывайте Write(String). Второй пример всегда вызывает WriteIf(Boolean, String), даже если mySwitch.TraceErrorfalse и выходные данные трассировки не создаются. Это может привести к ненужным выполнению произвольно сложного кода.

Первый пример:

C#
if(mySwitch.TraceError)
    Debug.Write("aNumber = " + aNumber + " out of range");

Второй пример:

C#
Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

См. также раздел

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

.NET 9 и другие версии
Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler, String)

Исходный код:
Debug.cs
Исходный код:
Debug.cs
Исходный код:
Debug.cs

Записывает имя категории и сообщение в прослушиватели трассировки в коллекции Listeners, если указанное условие true.

C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message, string? category);

Параметры

condition
Boolean

Условное выражение для вычисления. Если условие true, сообщение записывается в прослушиватели трассировки в коллекции.

message
Debug.WriteIfInterpolatedStringHandler

Сообщение для записи.

category
String

Имя категории, используемое для упорядочивания выходных данных.

Атрибуты

Комментарии

Эта перегрузка была введена в .NET 6 для повышения производительности. В сравнении с перегрузками, которые принимают параметр String, эта перегрузка оценивает только элементы интерполированного форматирования строк, если это сообщение необходимо.

По умолчанию выходные данные записываются в экземпляр DefaultTraceListener.

Используйте параметр category для группировки выходных сообщений.

Этот метод вызывает метод Write прослушивателя трассировки.

См. также раздел

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

.NET 9 и другие версии
Продукт Версии
.NET 6, 7, 8, 9

WriteIf(Boolean, Object, String)

Исходный код:
Debug.cs
Исходный код:
Debug.cs
Исходный код:
Debug.cs

Записывает имя категории и значение метода ToString() объекта в прослушиватели трассировки в коллекции Listeners, если условие true.

C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, object value, string category);
C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, object? value, string? category);

Параметры

condition
Boolean

Условное выражение для вычисления. Если условие true, имя и значение категории записываются в прослушиватели трассировки в коллекции.

value
Object

Объект, имя которого отправляется в Listeners.

category
String

Имя категории, используемое для упорядочивания выходных данных.

Атрибуты

Примеры

В следующем примере создается TraceSwitch с именем generalSwitch. Этот параметр задается за пределами примера кода.

Если для параметра задано значение TraceLevelVerbose, в примере выводится имя myObject и category в Listeners. Сведения о добавлении прослушивателя в коллекцию Listeners см. в классе TraceListenerCollection.

Затем, если для TraceLevel задано значение Error или выше, в примере выводится второе сообщение об ошибке в той же строке, что и первое сообщение. Терминатор строки следует второму сообщению.

C#
// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(Object myObject, string category)
{
    // Write the message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, myObject, category);

    // Write a second message if the TraceSwitch level is set to Error or higher.
    Debug.WriteLineIf(generalSwitch.TraceError, " Object is not valid for this category.");
}

Комментарии

По умолчанию выходные данные записываются в экземпляр DefaultTraceListener.

Параметр category можно использовать для группировки выходных сообщений.

Этот метод вызывает метод Write прослушивателя трассировки.

Примечания для тех, кто наследует этот метод

Вы можете свести к минимуму производительность инструментирования приложения с помощью инструкций If...Then вместо использования WriteIf(Boolean, String) инструкций. В следующих двух примерах кода отправляется одно и то же сообщение отладки. Однако первый пример гораздо быстрее при отключении трассировки, так как если mySwitch.TraceError оценивается false, не вызывайте Write(String). Второй пример всегда вызывает WriteIf(Boolean, String), даже если mySwitch.TraceErrorfalse и выходные данные трассировки не создаются. Это может привести к ненужным выполнению произвольно сложного кода.

Первый пример:

C#
if(mySwitch.TraceError)
    Debug.Write("aNumber = " + aNumber + " out of range");

Второй пример:

C#
Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

См. также раздел

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

.NET 9 и другие версии
Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

WriteIf(Boolean, String, String)

Исходный код:
Debug.cs
Исходный код:
Debug.cs
Исходный код:
Debug.cs

Записывает имя категории и сообщение в прослушиватели трассировки в коллекции Listeners, если условие true.

C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, string message, string category);
C#
[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, string? message, string? category);

Параметры

condition
Boolean

Условное выражение для вычисления. Если условие true, имя категории и сообщение записываются в прослушиватели трассировки в коллекции.

message
String

Сообщение для записи.

category
String

Имя категории, используемое для упорядочивания выходных данных.

Атрибуты

Примеры

В следующем примере создается TraceSwitch с именем generalSwitch. Этот параметр задается за пределами примера кода.

Если для параметра задано значение TraceLevelVerbose, в примере выводится первое сообщение об ошибке в Listeners. Сведения о добавлении прослушивателя в коллекцию Listeners см. в классе TraceListenerCollection.

Затем, если для TraceLevel задано значение Error или выше, в примере выводится второе сообщение об ошибке в той же строке, что и первое сообщение. Терминатор строки следует второму сообщению.

C#
// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(Object myObject, string category)
{
    // Write the message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, myObject.ToString() +
       " is not a valid object for category: ", category);

    // Write a second message if the TraceSwitch level is set to Error or higher.
    Debug.WriteLineIf(generalSwitch.TraceError, " Please use a different category.");
}

Комментарии

По умолчанию выходные данные записываются в экземпляр DefaultTraceListener.

Параметр category можно использовать для группировки выходных сообщений.

Этот метод вызывает метод TraceListener.Write прослушивателя трассировки.

Примечания для тех, кто наследует этот метод

Вы можете свести к минимуму производительность инструментирования приложения с помощью инструкций If...Then вместо использования WriteIf(Boolean, String) инструкций. В следующих двух примерах кода отправляется одно и то же сообщение отладки. Однако первый пример гораздо быстрее при отключении трассировки, так как если mySwitch.TraceError оценивается false, не вызывайте Write(String). Второй пример всегда вызывает WriteIf(Boolean, String), даже если mySwitch.TraceErrorfalse и выходные данные трассировки не создаются. Это может привести к ненужным выполнению произвольно сложного кода.

Первый пример:

C#
if(mySwitch.TraceError)
    Debug.Write("aNumber = " + aNumber + " out of range");

Второй пример:

C#
Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

См. также раздел

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

.NET 9 и другие версии
Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0