Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Fail Method (String)
Collapse the table of content
Expand the table of content

Debug.Fail Method (String)

Emits the specified error message.

Namespace:  System.Diagnostics
Assemblies:   System.Diagnostics.Debug (in System.Diagnostics.Debug.dll)
  System (in System.dll)

'Declaration
<ConditionalAttribute("DEBUG")> _
Public Shared Sub Fail ( _
	message As String _
)

Parameters

message
Type: System.String

A message to emit.

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.

NoteNote

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> Element for <listeners> for <trace>, the <remove> Element for <listeners> for <trace>, 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.

The following example uses the Fail method to print a message during exception handling.

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.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft