Exception.Data Exception.Data Exception.Data Exception.Data Property

Definition

Ruft eine Auflistung von Schlüssel-Wert-Paaren ab, die zusätzliche benutzerdefinierte Informationen über die Ausnahme bereitstellen.Gets a collection of key/value pairs that provide additional user-defined information about the exception.

public:
 virtual property System::Collections::IDictionary ^ Data { System::Collections::IDictionary ^ get(); };
public virtual System.Collections.IDictionary Data { get; }
member this.Data : System.Collections.IDictionary
Public Overridable ReadOnly Property Data As IDictionary

Eigenschaftswert

Ein Objekt, das die IDictionary-Schnittstelle implementiert und eine Auflistung benutzerdefinierter Schlüssel-Wert-Paare enthält.An object that implements the IDictionary interface and contains a collection of user-defined key/value pairs. Der Standard ist eine leere Auflistung.The default is an empty collection.

Beispiele

Das folgende Beispiel zeigt das Hinzufügen und Abrufen von Informationen mithilfe der Data Eigenschaft.The following example demonstrates how to add and retrieve information using the Data property.

using namespace System;
using namespace System::Collections;

void NestedRunTest( bool displayDetails ); // forward declarations
void NestedRoutine1( bool displayDetails );
void NestedRoutine2( bool displayDetails );
void RunTest( bool displayDetails );

int main()
{
   Console::WriteLine("\nException with some extra information..." );
   RunTest(false);
   Console::WriteLine("\nException with all extra information..." );
   RunTest(true);
}

void RunTest( bool displayDetails )
{
   try
   {
      NestedRoutine1( displayDetails );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "An exception was thrown." );
      Console::WriteLine( e->Message );
      if ( e->Data != nullptr )
      {
         Console::WriteLine( "  Extra details:" );

         for each (DictionaryEntry de in e->Data)
            Console::WriteLine("    Key: {0,-20}      Value: {1}", 
                               "'" + de.Key->ToString() + "'", de.Value);
      }
   }
}

void NestedRoutine1( bool displayDetails )
{
   try
   {
      NestedRoutine2( displayDetails );
   }
   catch ( Exception^ e ) 
   {
      e->Data[ "ExtraInfo" ] = "Information from NestedRoutine1.";
      e->Data->Add( "MoreExtraInfo", "More information from NestedRoutine1." );
      throw;
   }
}

void NestedRoutine2( bool displayDetails )
{
   Exception^ e = gcnew Exception( "This statement is the original exception message." );
   if ( displayDetails )
   {
      String^ s = "Information from NestedRoutine2.";
      int i = -903;
      DateTime dt = DateTime::Now;
      e->Data->Add( "stringInfo", s );
      e->Data[ "IntInfo" ] = i;
      e->Data[ "DateTimeInfo" ] = dt;
   }

   throw e;
}

/*
This example produces the following results:

Exception with some extra information...
An exception was thrown.
This statement is the original exception message.
  Extra details:
    The key is 'ExtraInfo' and the value is: Information from NestedRoutine1.
    The key is 'MoreExtraInfo' and the value is: More information from NestedRoutine1.

Exception with all extra information...
An exception was thrown.
This statement is the original exception message.
  Extra details:
    The key is 'stringInfo' and the value is: Information from NestedRoutine2.
    The key is 'IntInfo' and the value is: -903
    The key is 'DateTimeInfo' and the value is: 11/26/2002 2:12:58 PM
    The key is 'ExtraInfo' and the value is: Information from NestedRoutine1.
    The key is 'MoreExtraInfo' and the value is: More information from NestedRoutine1.
*/
// This example demonstrates the Exception.Data property.
using System;
using System.Collections;

class Sample 
{
   public static void Main()
   {
      Console.WriteLine("\nException with some extra information...");
      RunTest(false);
      Console.WriteLine("\nException with all extra information...");
      RunTest(true);
   }

   public static void RunTest(bool displayDetails)
   {
      try {
         NestedRoutine1(displayDetails);
      }
      catch (Exception e) {
         Console.WriteLine("An exception was thrown.");
         Console.WriteLine(e.Message);
         if (e.Data.Count > 0) {
            Console.WriteLine("  Extra details:");
            foreach (DictionaryEntry de in e.Data)
               Console.WriteLine("    Key: {0,-20}      Value: {1}", 
                                 "'" + de.Key.ToString() + "'", de.Value);
         }
      }
   }
    
   public static void NestedRoutine1(bool displayDetails)
   {
      try {
         NestedRoutine2(displayDetails);
      }
      catch (Exception e) {
         e.Data["ExtraInfo"] = "Information from NestedRoutine1.";
         e.Data.Add("MoreExtraInfo", "More information from NestedRoutine1.");
         throw;
      }
   }
    
   public static void NestedRoutine2(bool displayDetails)
   {
      Exception e = new Exception("This statement is the original exception message.");
      if (displayDetails) {
         string s = "Information from NestedRoutine2.";
         int i = -903;
         DateTime dt = DateTime.Now;
         e.Data.Add("stringInfo", s);
         e.Data["IntInfo"] = i;
         e.Data["DateTimeInfo"] = dt;
      }
      throw e;
   }
}
// The example displays the following output: 
//    Exception with some extra information...
//    An exception was thrown.
//    This statement is the original exception message.
//      Extra details:                                               
//        Key: 'ExtraInfo'               Value: Information from NestedRoutine1.
//        Key: 'MoreExtraInfo'           Value: More information from NestedRoutine1.
//    
//    Exception with all extra information...
//    An exception was thrown.
//    This statement is the original exception message.
//      Extra details:
//        Key: 'stringInfo'              Value: Information from NestedRoutine2.
//        Key: 'IntInfo'                 Value: -903
//        Key: 'DateTimeInfo'            Value: 7/29/2013 10:50:13 AM
//        Key: 'ExtraInfo'               Value: Information from NestedRoutine1.
//        Key: 'MoreExtraInfo'           Value: More information from NestedRoutine1. 
Imports System.Collections

Module Example
   Public Sub Main()
      Console.WriteLine()
      Console.WriteLine("Exception with some extra information...")
      RunTest(False)
      Console.WriteLine()
      Console.WriteLine("Exception with all extra information...")
      RunTest(True)
   End Sub

   Public Sub RunTest(displayDetails As Boolean)
      Try
         NestedRoutine1(displayDetails)
      Catch e As Exception
         Console.WriteLine("An exception was thrown.")
         Console.WriteLine(e.Message)
         If e.Data.Count > 0 Then
            Console.WriteLine("  Extra details:")
            For Each de As DictionaryEntry In e.Data
               Console.WriteLine("    Key: {0,-20}      Value: {1}",
                                 "'" + de.Key.ToString() + "'", de.Value)
            Next
         End If 
      End Try 
   End Sub 

   Public Sub NestedRoutine1(displayDetails As Boolean)
      Try
         NestedRoutine2(displayDetails)
      Catch e As Exception
         e.Data("ExtraInfo") = "Information from NestedRoutine1."
         e.Data.Add("MoreExtraInfo", "More information from NestedRoutine1.")
         Throw e
      End Try 
   End Sub

   Public Sub NestedRoutine2(displayDetails As Boolean)
      Dim e As New Exception("This statement is the original exception message.")
      If displayDetails Then 
         Dim s As String = "Information from NestedRoutine2." 
         Dim i As Integer = -903
         Dim dt As DateTime = DateTime.Now
         e.Data.Add("stringInfo", s)
         e.Data("IntInfo") = i
         e.Data("DateTimeInfo") = dt
      End If 
      Throw e
   End Sub 
End Module
' This example displays the following output: 
'    Exception with some extra information...
'    An exception was thrown.
'    This statement is the original exception message.
'      Extra details:
'        Key: 'ExtraInfo'               Value: Information from NestedRoutine1.
'        Key: 'MoreExtraInfo'           Value: More information from NestedRoutine1.
'    
'    Exception with all extra information...
'    An exception was thrown.
'    This statement is the original exception message.
'      Extra details:
'        Key: 'stringInfo'              Value: Information from NestedRoutine2.
'        Key: 'IntInfo'                 Value: -903
'        Key: 'DateTimeInfo'            Value: 7/29/2013 10:50:13 AM
'        Key: 'ExtraInfo'               Value: Information from NestedRoutine1.
'        Key: 'MoreExtraInfo'           Value: More information from NestedRoutine1. 

Hinweise

Verwenden der System.Collections.IDictionary zurückgegebenes Objekt der Data Eigenschaft zum Speichern und Abrufen von zusätzlichen Informationen über die Ausnahme.Use the System.Collections.IDictionary object returned by the Data property to store and retrieve supplementary information relevant to the exception. Die Informationen sind in Form von einer beliebigen Anzahl von benutzerdefinierten Schlüssel/Wert-Paaren.The information is in the form of an arbitrary number of user-defined key/value pairs. Die wichtige Komponente jedes Schlüssel-Wert-Paars ist in der Regel eine identifizierende Zeichenfolge ist, während die Wertkomponente des Paars auf jede Art von Objekt sein kann.The key component of each key/value pair is typically an identifying string, whereas the value component of the pair can be any type of object.

Schlüssel/Wert-Paar-SicherheitKey/Value Pair Security

Die Schlüssel-/Wertpaare gespeichert, in der Auflistung zurückgegeben werden, indem die Data Eigenschaft sind nicht sicher.The key/value pairs stored in the collection returned by the Data property are not secure. Wenn die Anwendung, eine geschachtelte Reihe von Routinen aufruft, und jede Routine Ausnahmehandler enthält, enthält die daraus entstehende Aufrufliste eine Hierarchie der Ausnahmehandler.If your application calls a nested series of routines, and each routine contains exception handlers, the resulting call stack contains a hierarchy of those exception handlers. Wenn eine untergeordnete Routine eine Ausnahme auslöst, kann alle übergeordneten Ausnahmehandler in der Stack Aufrufhierarchie gelesen und/oder Ändern der Schlüssel-/Wertpaaren, die von jedem anderen Ausnahmehandler in der Auflistung gespeichert.If a lower-level routine throws an exception, any upper-level exception handler in the call stack hierarchy can read and/or modify the key/value pairs stored in the collection by any other exception handler. Dies bedeutet, dass Sie sicherstellen müssen, dass die Informationen im Schlüssel/Wert-Paare nicht vertraulich sind und Ihre Anwendung ordnungsgemäß ausgeführt wird, wenn die Informationen in der Schlüssel-/Wertpaaren beschädigt ist.This means you must guarantee that the information in the key/value pairs is not confidential and that your application will operate correctly if the information in the key/value pairs is corrupted.

ID-KonflikteKey Conflicts

Ein Schlüssel Konflikt tritt bei der anderen Ausnahmehandler Schlüssel/Wert-Paar auf den gleichen Schlüssel.A key conflict occurs when different exception handlers specify the same key to access a key/value pair. Vorsichtig, wenn Ihre Anwendung zu entwickeln, da die Folge von einem Konflikt mit Schlüssel ist, dass das Low-Level-Ausnahmehandler versehentlich mit Ausnahmehandler auf höherer Ebene kommunizieren können, und diese Kommunikation möglicherweise geringfügige Programmfehler.Use caution when developing your application because the consequence of a key conflict is that lower-level exception handlers can inadvertently communicate with higher-level exception handlers, and this communication might cause subtle program errors. Jedoch wenn Sie vorsichtig sind können wichtige Konflikte Sie um Ihre Anwendung zu optimieren.However, if you are cautious you can use key conflicts to enhance your application.

Vermeiden von Konflikten mit SchlüsselAvoiding Key Conflicts

Vermeiden Sie durch die Einführung einer Benennungskonvention zum Generieren von eindeutigen Schlüssel für Schlüssel/Wert-Paaren.Avoid key conflicts by adopting a naming convention to generate unique keys for key/value pairs. Beispielsweise könnte eine Benennungskonvention ergeben, einen Schlüssel, der den Punkt getrennte Namen der Anwendung besteht, die Methode, die zusätzliche Informationen für das Paar und einen eindeutigen Bezeichner enthält.For example, a naming convention might yield a key that consists of the period-delimited name of your application, the method that provides supplementary information for the pair, and a unique identifier.

Angenommen, zwei Anwendungen, mit dem Namen Produkten und Lieferanten, besitzt jeder eine Methode mit dem Namen Sales.Suppose two applications, named Products and Suppliers, each has a method named Sales. Die Sales-Methode in der Anwendung Produkte stellt die ID-Nummer (die Stock keeping Unit bzw. SKU) eines Produkts bereit.The Sales method in the Products application provides the identification number (the stock keeping unit or SKU) of a product. Die Sales-Methode in der Lieferanten-Anwendung enthält die ID-Nummer oder die SID, von einem Lieferanten.The Sales method in the Suppliers application provides the identification number, or SID, of a supplier. Die Namenskonvention für dieses Beispiel ergibt daher den Schlüssel, "Products.Sales.SKU" und "Suppliers.Sales.SID".Consequently, the naming convention for this example yields the keys, "Products.Sales.SKU" and "Suppliers.Sales.SID".

Ausnutzen-KonflikteExploiting Key Conflicts

Nutzen Sie aus, indem Sie mit der Steuerung der Verarbeitung durch das Vorhandensein von ein oder mehrere spezielle, vordefinierten Schlüssel.Exploit key conflicts by using the presence of one or more special, prearranged keys to control processing. Nehmen wir an, in einem Szenario der höchsten Ebene Ausnahmehandler im Stapel Anrufhierarchie alle von Low-Level-Ausnahmehandler ausgelöste Ausnahmen abfängt.Suppose, in one scenario, the highest level exception handler in the call stack hierarchy catches all exceptions thrown by lower-level exception handlers. Wenn ein Schlüssel/Wert-Paar mit einem speziellen Schlüssel vorhanden ist, formatiert der hohen Ausnahmehandler verbleibenden Schlüssel/Wert-Paare in der IDictionary Objekt nicht dem Standard entsprechende irgendwie; andernfalls werden die restlichen Schlüssel/Wert-Paare auf normale Weise formatiert.If a key/value pair with a special key exists, the high-level exception handler formats the remaining key/value pairs in the IDictionary object in some nonstandard way; otherwise, the remaining key/value pairs are formatted in some normal manner.

Nehmen wir nun an, in einem anderen Szenario wird der Ausnahmehandler auf jeder Ebene der Hierarchie Stack Aufruf von der nächsten Ausnahmehandler von Low-Level-ausgelöste Ausnahme abfängt.Now suppose, in another scenario, the exception handler at each level of the call stack hierarchy catches the exception thrown by the next lower-level exception handler. Darüber hinaus jeden Ausnahmehandler von zurückgegebene Auflistung kennt die Data Eigenschaft enthält einen Satz von Schlüssel/Wert-Paaren, die zugegriffen werden kann, mit einem vordefinierten Satz von Schlüsseln.In addition, each exception handler knows the collection returned by the Data property contains a set of key/value pairs that can be accessed with a prearranged set of keys.

Jeder Ausnahmehandler verwendet den vordefinierten Satz von Schlüsseln, um die Wertkomponente des entsprechenden Schlüssel/Wert-Paar mit Informationen, die nur für dieser Ausnahmehandler zu aktualisieren.Each exception handler uses the prearranged set of keys to update the value component of the corresponding key/value pair with information unique to that exception handler. Nachdem der Aktualisierungsvorgang abgeschlossen ist, löst die Ausnahme an den nächsten Ausnahmehandler auf höherer Ebene von der Ausnahmehandler aus.After the update process is complete, the exception handler throws the exception to the next higher-level exception handler. Abschließend wird der Ausnahmehandler auf höchste Ebene greift auf die Schlüssel/Wert-Paare und zeigt die konsolidierte Updateinformationen über die Low-Level-Ausnahmehandler.Finally, the highest level exception handler accesses the key/value pairs and displays the consolidated update information from all the lower-level exception handlers.

Gilt für:

Siehe auch