Exception.ToString Méthode

Définition

Espace de noms:

System

Assembly:

System.Runtime.dll

Assembly:

mscorlib.dll

Assembly:

netstandard.dll

Crée et retourne une chaîne représentant l'exception actuelle.

C#

public override string ToString ();

Retours

String

Représentation sous forme de chaîne de l'exception actuelle.

Implémente

ToString()

Exemples

L’exemple suivant provoque une exception et affiche le résultat de l’appel ToString sur cette exception. Notez que la Exception.ToString méthode est appelée implicitement lorsque l’instance de classe Exception apparaît dans la liste d’arguments de la Console.WriteLine méthode.

C#

using System;

public class TestClass
{}

public class Example
{
   public static void Main()
   {
      var test = new TestClass();
      Object[] objectsToCompare = { test, test.ToString(), 123,
                                    123.ToString(), "some text",
                                    "Some Text" };
      string s = "some text";
      foreach (var objectToCompare in objectsToCompare) {
         try {
            int i = s.CompareTo(objectToCompare);
            Console.WriteLine("Comparing '{0}' with '{1}': {2}",
                              s, objectToCompare, i);
         }
         catch (ArgumentException e) {
            Console.WriteLine("Bad argument: {0} (type {1})",
                              objectToCompare,
                              objectToCompare.GetType().Name);
            Console.WriteLine("Exception information: {0}", e);
         }
         Console.WriteLine();
      }
   }
}
// The example displays the following output:
//     Bad argument: TestClass (type TestClass)
//     Exception information: System.ArgumentException: Object must be of type String.
//        at System.String.CompareTo(Object value)
//        at Example.Main()
//
//     Comparing 'some text' with 'TestClass': -1
//
//     Bad argument: 123 (type Int32)
//     Exception information: System.ArgumentException: Object must be of type String.
//        at System.String.CompareTo(Object value)
//        at Example.Main()
//
//     Comparing 'some text' with '123': 1
//
//     Comparing 'some text' with 'some text': 0
//
//     Comparing 'some text' with 'Some Text': -1

Remarques

ToString retourne une représentation de l’exception actuelle destinée à être comprise par les humains. Lorsque l’exception contient des données sensibles à la culture, la représentation sous forme de chaîne retournée ToString est nécessaire pour prendre en compte la culture système actuelle. Bien qu’il n’existe aucune exigence exacte pour le format de la chaîne retournée, il doit tenter de refléter la valeur de l’objet tel qu’il est perçu par l’utilisateur.

L’implémentation par défaut obtient le nom de la classe qui a levé l’exception actuelle, le message, le résultat de ToString l’appel ToString sur l’exception interne et le résultat de l’appel Environment.StackTrace. Si l’un de ces membres est null, sa valeur n’est pas incluse dans la chaîne retournée.

S’il n’y a pas de message d’erreur ou s’il s’agit d’une chaîne vide («  »), aucun message d’erreur n’est retourné. Le nom de l’exception interne et la trace de pile sont retournés uniquement s’ils ne le sont pas null.

Cette méthode se substitue à Object.ToString.

S’applique à