asp.net.ph

Exception.ToString Method

System Namespace   Exception Class


Creates and returns a string representation of the current exception.

[ VB ]
<Serializable>
<ClassInterface ( ClassInterfaceType.AutoDual ) >
Overrides Public Function ToString ( ) As String

[ C# ]
[ Serializable ]
[ ClassInterface ( ClassInterfaceType.AutoDual ) ]
public override string ToString ( );

[ C++ ]
[ Serializable ]
[ ClassInterface ( ClassInterfaceType.AutoDual ) ]
public: String* ToString ( );

[ JScript ]
public Serializable
   ClassInterface ( ClassInterfaceType.AutoDual )
override function ToString ( ) : String;

Return Value

A string representation of the current exception.

Remarks

ToString returns a representation of the current exception that is intended to be understood by humans. Where the exception contains culture-sensitive data, the string representation returned by ToString is required to take into account the current system culture. Although there are no exact requirements for the format of the returned string, it should attempt to reflect the value of the object as perceived by the user.

The default implementation of Exception.ToString obtains the name of the class that threw the current exception, the message, the result of calling ToString on the inner exception, and the result of calling Environment.StackTrace. If any of these members is a null reference ( Nothing in Visual Basic ), its value is not included in the returned string.

If there is no error message or if it is an empty string ( "" ), then no error message is returned. The name of the inner exception and the stack trace are returned only if they are not a null reference.

This method overrides Object.ToString.

Notes to Inheritors: It is recommended, but not required, that ToString be overridden to return information about members declared in the derived class. For example, the ArgumentException class implements ToString so that it returns the value of the ParamName property, if that value is not a null reference.

Example

[ VB, C#, JScript ] The following example causes an exception and displays the result of calling ToString on that exception.

[ VB ]
Imports System

Public Class [ MyClass ]
End Class ' [ MyClass ]

Public Class ArgExceptionExample

   Public Shared Sub Main ( )
      Dim my As New [ MyClass ] ( )
      Dim s As String = "sometext"
      Try
         Dim i As Integer = s.CompareTo ( my )
      Catch e As Exception
         Response.Write ( "Error: {0}", e.ToString ( ) )
      End Try
   End Sub 'Main
End Class 'ArgExceptionExample

[ C# ]
using System;

public class MyClass {}
public class ArgExceptionExample
   {
   public static void Main ( )
      {
      MyClass my = new MyClass ( );
      string s = "sometext";
      try
         {
         int i = s.CompareTo ( my );
         }
            catch ( Exception e )
            {
            Response.Write ( "Error: {0}",e.ToString ( ) );
            }
      }
}

[ JScript ]
import System;

public class MyClass {}
public class ArgExceptionExample
   {
   public static function Main ( )
      {
      var my : MyClass = new MyClass ( );
      var s : String = "sometext";
      try
         {
         var i : int = s.CompareTo ( my );
         }
     catch ( e : Exception )
         {
         Response.Write ( "Error: {0}",e.ToString ( ) );
         }
      }
}

[ VB, C#, JScript ] This code has the following output:

[ VB, C#, JScript ] Error:

System.ArgumentException: Object must be of type String. at

System.String.CompareTo ( Object value ) at ArgExceptionExample.Main ( )

See Also

Exception Members Skip Navigation Links




Home
Suggested Reading


Previous page Back to top Next page

© 2000-2010 Rey Nuñez All rights reserved.

If you have any question, comment or suggestion
about this site, please send us a note

You can help support asp.net.ph