Trace.Fail Method (String, String)

 

Emits an error message, and a detailed error message.

Namespace:   System.Diagnostics
Assembly:  System (in System.dll)

[ConditionalAttribute("TRACE")]
public static void Fail(
	string message,
	string detailMessage
)

Parameters

message
Type: System.String

A message to emit.

detailMessage
Type: System.String

A detailed message to emit.

The default behavior is for the default trace listener to output the message parameter and the detailedMessage parameter to a message box when the application runs in user-interface mode, and to the TraceListener instances in the Listeners collection.

System_CAPS_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 by removing one from, the Listeners collection.

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

catch (Exception) {
    Trace.Fail("Invalid value: " + value.ToString(), 
       "Resetting value to newValue.");
    value = newValue;
}

You can also use the Fail method in a switch statement.

switch (option) {
    case Option.First:
       result = 1.0;
       break;

    // Insert additional cases.

    default:
       Trace.Fail("Unsupported option " + option, "Result set to 1.0");
       result = 1.0;
       break;
}

.NET Framework
Available since 1.1
Return to top
Show: