This documentation is archived and is not being maintained.

Trace.Fail Method (String, String)

Emits an error message, and a detailed error message.

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

[ConditionalAttribute(L"TRACE")] 
public:
static void Fail (
	String^ message, 
	String^ detailMessage
)
/** @attribute ConditionalAttribute("TRACE") */ 
public static void Fail (
	String message, 
	String detailMessage
)
ConditionalAttribute("TRACE") 
public static function Fail (
	message : String, 
	detailMessage : String
)
Not applicable.

Parameters

message

A message to emit.

detailMessage

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.

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^ ) 
{
  #if defined(TRACE)
  Trace::Fail( String::Format( "Invalid value: {0}", value ),
      "Resetting value to newValue." );
   #endif
   value = newValue;
}

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

catch(e : Exception)
{
    @if(@TRACE)
    Trace.Fail("Invalid value: " + value.ToString(), 
       "Resetting value to newValue.")
    @end
    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:
      #if defined(TRACE)
      Trace::Fail( String::Format( "Unsupported option {0}", option ),
         "Result set to 1.0" );
      #endif
      result = 1.0;
      break;
}

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;
}

switch(option)
{
    case 1:
        result = 1.0
        break
    
  // Insert additional cases.
  
    default:
        @if(@TRACE)
        Trace.Fail("Unknown option: " + option, "result set to 1.0")
        @end
        result = 1.0
}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

XNA Framework

Supported in: 1.0
Show: