Debug.Fail Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Emits an error message.
| Fail(String, String) |
Emits an error message and a detailed error message. |
| Fail(String) |
Emits the specified error message. |
- Source:
- Debug.cs
- Source:
- Debug.cs
- Source:
- Debug.cs
Emits an error message and a detailed error message.
public:
static void Fail(System::String ^ message, System::String ^ detailMessage);[System.Diagnostics.Conditional("DEBUG")]
public static void Fail(string message, string detailMessage);[System.Diagnostics.Conditional("DEBUG")]
public static void Fail(string? message, string? detailMessage);[<System.Diagnostics.Conditional("DEBUG")>]
static member Fail : string * string -> unitPublic Shared Sub Fail (message As String, detailMessage As String)Parameters
- message
- String
A message to emit.
- detailMessage
- String
A detailed message to emit.
- Attributes
Examples
The following example uses the Fail method to print a message during exception handling.
catch ( Exception^ e )
{
#if defined(DEBUG)
Debug::Fail( "Cannot find SpecialController, proceeding with StandardController", "Setting Controller to default value" );
#endif
}
catch (Exception)
{
Debug.Fail("Invalid value: " + value.ToString(),
"Resetting value to newValue.");
value = newValue;
}
Catch e As Exception
Debug.Fail("Invalid value: " + value.ToString(), "Resetting value to newValue.")
value = newValue
End Try
You can also use the Fail method in a switch statement.
switch ( option )
{
case Option::First:
result = 1.0;
break;
// Insert additional cases.
default:
#if defined(DEBUG)
Debug::Fail( "Unknown Option" + option, "Result set to 1.0" );
#endif
result = 1.0;
break;
}
switch (option1)
{
case MyOption.First:
result = 1.0;
break;
// Insert additional cases.
default:
Debug.Fail("Unknown Option " + option1, "Result set to 1.0");
result = 1.0;
break;
}
Select Case option1
Case MyOption.First
result = 1.0
' Insert additional cases.
Case Else
Debug.Fail("Unknown Option " & option1, "Result set to 1.0")
result = 1.0
End Select
Remarks
The default behavior is that the DefaultTraceListener outputs the message to a message box when the application is running in user interface mode and to the TraceListener instances in the Listeners collection.
Note
The display of the message box is dependent on the presence of the DefaultTraceListener. If the DefaultTraceListener is not in the Listeners collection, the message box is not displayed. The DefaultTraceListener can be removed by the <clear>, the <remove>, or by calling the Clear method on the Listeners property (System.Diagnostics.Trace.Listeners.Clear()).
You can customize this behavior by adding a TraceListener to, or removing one from, the Listeners collection.
See also
- Debug
- Trace
- BooleanSwitch
- TraceSwitch
- TraceListener
- DefaultTraceListener
- ConsoleTraceListener
- ConditionalAttribute
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .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, 10 |
| .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 |
- Source:
- Debug.cs
- Source:
- Debug.cs
- Source:
- Debug.cs
Emits the specified error message.
public:
static void Fail(System::String ^ message);[System.Diagnostics.Conditional("DEBUG")]
public static void Fail(string message);[System.Diagnostics.Conditional("DEBUG")]
public static void Fail(string? message);[<System.Diagnostics.Conditional("DEBUG")>]
static member Fail : string -> unitPublic Shared Sub Fail (message As String)Parameters
- message
- String
A message to emit.
- Attributes
Examples
The following example uses the Fail method to print a message during exception handling.
catch ( Exception^ e )
{
#if defined(DEBUG)
Debug::Fail( "Unknown Option " + option + ", using the default." );
#endif
}
catch (Exception)
{
Debug.Fail("Unknown Option " + option + ", using the default.");
}
Catch e As Exception
Debug.Fail("Unknown Option " + myOption1 + ", using the default.")
End Try
You can also use the Fail method in a switch statement.
switch ( option )
{
case Option::First:
result = 1.0;
break;
// Insert additional cases.
default:
#if defined(DEBUG)
Debug::Fail( "Unknown Option" + option );
#endif
result = 1.0;
break;
}
switch (option)
{
case Option.First:
result = 1.0;
break;
// Insert additional cases.
default:
Debug.Fail("Unknown Option " + option);
result = 1.0;
break;
}
Select Case myOption1
Case MyOption.First
result = 1.0
' Insert additional cases.
Case Else
Debug.Fail(("Unknown Option " & myOption1.ToString))
result = 1.0
End Select
Remarks
The default behavior is that the DefaultTraceListener outputs the message to a message box when the application is running in user interface mode and to the TraceListener instances in the Listeners collection.
Note
The display of the message box is dependent on the presence of the DefaultTraceListener. If the DefaultTraceListener is not in the Listeners collection, the message box is not displayed. The DefaultTraceListener can be removed by the <clear>, the <remove>, or by calling the Clear method on the Listeners property (System.Diagnostics.Trace.Listeners.Clear()).
You can customize this behavior by adding a TraceListener to, or removing one from, the Listeners collection.
See also
- Debug
- Trace
- BooleanSwitch
- TraceSwitch
- TraceListener
- DefaultTraceListener
- ConsoleTraceListener
- ConditionalAttribute
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .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, 10 |
| .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 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: