ThreadExceptionEventArgs Class (System.Threading)

Switch View :
ScriptFree
.NET Framework Class Library
ThreadExceptionEventArgs Class

Provides data for the ThreadException event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    System.Threading.ThreadExceptionEventArgs
      Microsoft.VisualBasic.ApplicationServices.UnhandledExceptionEventArgs

Namespace:  System.Threading
Assembly:  System (in System.dll)
Syntax

Visual Basic
Public Class ThreadExceptionEventArgs _
	Inherits EventArgs
C#
public class ThreadExceptionEventArgs : EventArgs
Visual C++
public ref class ThreadExceptionEventArgs : public EventArgs
F#
type ThreadExceptionEventArgs =  
    class
        inherit EventArgs
    end

The ThreadExceptionEventArgs type exposes the following members.

Constructors

  Name Description
Public method ThreadExceptionEventArgs Initializes a new instance of the ThreadExceptionEventArgs class.
Top
Properties

  Name Description
Public property Exception Gets the Exception that occurred.
Top
Methods

  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

A ThreadExceptionEventArgs is created by a thread when an unhandled exception occurs. ThreadExceptionEventArgs contains the Exception that occurred.

Examples

The following example allows you to raise a ThreadException event by clicking button1 on a form. The example creates two classes. The ErrorHandler class creates the form and the button that raises the event. The CustomExceptionHandler class provides the methods to handle the exception.

In Main in the ErrorHandler class, the code creates a new instance of the exception handling class, that is, an instance of the CustomExceptionHandler. Then the instance is added to the event, and the application is run.

In the OnThreadException method in the CustomExceptionHandler class, the example uses a try...catch...finally statement to process the exception. The ShowThreadExceptionDialog method creates the message to display, and displays it in a message box.

Visual Basic

' Creates a class to throw the error.
Public Class ErrorHandler
    Inherits System.Windows.Forms.Form    

    ' Inserts code to create a form with a button.

    ' Programs the button to throw the exception when clicked.
    Private Sub button1_Click(sender As Object, e As System.EventArgs)
        Throw New ArgumentException("The parameter was invalid")
    End Sub

    Public Shared Sub Main()
        ' Creates an instance of the methods that will handle the exception.
        Dim eh As New CustomExceptionHandler()

        ' Adds the event handler to to the event.
        AddHandler Application.ThreadException, AddressOf eh.OnThreadException

        ' Runs the application.
        Application.Run(New ErrorHandler())
    End Sub

End Class

' Creates a class to handle the exception event.
Friend Class CustomExceptionHandler

    'Handles the exception event
    Public Sub OnThreadException(sender As Object, t As ThreadExceptionEventArgs)
        Dim result As DialogResult = DialogResult.Cancel
        Try
            result = Me.ShowThreadExceptionDialog(t.Exception)
        Catch
            Try
                MessageBox.Show("Fatal Error", "Fatal Error", _
                    MessageBoxButtons.AbortRetryIgnore, MessageBoxIcon.Stop)
            Finally
                Application.Exit()
            End Try
        End Try

        ' Exits the program when the user clicks Abort.
        If result = DialogResult.Abort Then
            Application.Exit()
        End If
    End Sub

    ' Creates the error message and display it.
    Private Function ShowThreadExceptionDialog(e As Exception) As DialogResult
        Dim errorMsg As String = "An error occurred please contact the " & _
            "adminstrator with the following information:" & _
            Microsoft.VisualBasic.ControlChars.Cr & _
            Microsoft.VisualBasic.ControlChars.Cr
        errorMsg &= e.Message & Microsoft.VisualBasic.ControlChars.Cr & _
            Microsoft.VisualBasic.ControlChars.Cr & "Stack Trace:" & _
            Microsoft.VisualBasic.ControlChars.Cr & e.StackTrace
        Return MessageBox.Show(errorMsg, "Application Error", _
            MessageBoxButtons.AbortRetryIgnore, MessageBoxIcon.Stop)
    End Function
End Class



C#

// Creates a class to throw the error.
 public class ErrorHandler : System.Windows.Forms.Form {

    // Inserts code to create a form with a button.

    // Programs the button to throw the exception when clicked.
    private void button1_Click(object sender, System.EventArgs e) {
       throw new ArgumentException("The parameter was invalid");
    }

    public static void Main(string[] args) {
       // Creates an instance of the methods that will handle the exception.
       CustomExceptionHandler eh = new CustomExceptionHandler();

       // Adds the event handler to to the event.
       Application.ThreadException += new ThreadExceptionEventHandler(eh.OnThreadException);

       // Runs the application.
       Application.Run(new ErrorHandler());
    }
 }

 // Creates a class to handle the exception event.
 internal class CustomExceptionHandler {

    //Handles the exception event
    public void OnThreadException(object sender, ThreadExceptionEventArgs t) 
    {
       DialogResult result = DialogResult.Cancel;
       try {
          result = this.ShowThreadExceptionDialog(t.Exception);
       }
       catch {
          try {
             MessageBox.Show("Fatal Error", "Fatal Error", 
                MessageBoxButtons.AbortRetryIgnore, MessageBoxIcon.Stop);
          }
          finally {
             Application.Exit();
          }
       }

       // Exits the program when the user clicks Abort.
       if (result == DialogResult.Abort) 
          Application.Exit();
    }

    // Creates the error message and display it.
    private DialogResult ShowThreadExceptionDialog(Exception e) {
       string errorMsg = "An error occurred please contact the adminstrator " +
            "with the following information:\n\n";
       errorMsg = errorMsg + e.Message + "\n\nStack Trace:\n" + e.StackTrace;
       return MessageBox.Show(errorMsg, "Application Error", 
            MessageBoxButtons.AbortRetryIgnore, MessageBoxIcon.Stop);
    }
 }
 


Visual C++

// Creates a class to handle the exception event.
private ref class CustomExceptionHandler
{
public:

   //Handles the exception event
   void OnThreadException( Object^ /*sender*/, ThreadExceptionEventArgs^ t )
   {
      DialogResult result = DialogResult::Cancel;
      try
      {
         result = this->ShowThreadExceptionDialog( t->Exception );
      }
      catch ( Exception^ ) 
      {
         try
         {
            MessageBox::Show( "Fatal Error", "Fatal Error", MessageBoxButtons::AbortRetryIgnore, MessageBoxIcon::Stop );
         }
         finally
         {
            Application::Exit();
         }

      }


      // Exits the program when the user clicks Abort.
      if ( result == DialogResult::Abort )
            Application::Exit();
   }


private:

   // Creates the error message and display it.
   DialogResult ShowThreadExceptionDialog( Exception^ e )
   {
      String^ errorMsg = "An error occurred please contact the adminstrator with the following information:\n\n";
      errorMsg = String::Concat( errorMsg, e->Message, "\n\nStack Trace:\n", e->StackTrace );
      return MessageBox::Show( errorMsg, "Application Error", MessageBoxButtons::AbortRetryIgnore, MessageBoxIcon::Stop );
   }

};


// Creates a class to throw the error.
public ref class ErrorHandler: public System::Windows::Forms::Form
{
private:

   // Inserts code to create a form with a button.
   // Programs the button to throw the exception when clicked.
   void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      throw gcnew ArgumentException( "The parameter was invalid" );
   }

};

int main()
{

   // Creates an instance of the methods that will handle the exception.
   CustomExceptionHandler^ eh = gcnew CustomExceptionHandler;

   // Adds the event handler to to the event.
   Application::ThreadException += gcnew ThreadExceptionEventHandler( eh, &CustomExceptionHandler::OnThreadException );

   // Runs the application.
   Application::Run( gcnew ErrorHandler );
}



Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference