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

Definice

Získá kolekci párů klíč/hodnota, které poskytují další uživatelsky definované informace o výjimce.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

Hodnota vlastnosti

Objekt, který implementuje IDictionary rozhraní a obsahuje kolekci uživatelsky definovaných párů klíč/hodnota.An object that implements the IDictionary interface and contains a collection of user-defined key/value pairs. Výchozí hodnotou je prázdná kolekce.The default is an empty collection.

Příklady

Následující příklad ukazuje, jak přidat a načíst informace pomocí Data vlastnosti.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. 

Poznámky

Pomocí objektu vráceného Data vlastností uložte a načtěte doplňující informace, které jsou relevantní pro výjimku. System.Collections.IDictionaryUse the System.Collections.IDictionary object returned by the Data property to store and retrieve supplementary information relevant to the exception. Informace jsou ve formě libovolného počtu uživatelem definovaných párů klíč/hodnota.The information is in the form of an arbitrary number of user-defined key/value pairs. Klíčovou součástí každého páru klíč/hodnota je obvykle identifikační řetězec, zatímco hodnota komponenty páru může být libovolný typ objektu.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.

Zabezpečení dvojice klíč/hodnotaKey/Value Pair Security

Páry klíč/hodnota uložené v kolekci vrácené Data vlastností nejsou zabezpečené.The key/value pairs stored in the collection returned by the Data property are not secure. Pokud vaše aplikace zavolá vnořenou sérii rutin a každá rutina obsahuje obslužné rutiny výjimek, výsledný zásobník volání obsahuje hierarchii těchto obslužných rutin výjimek.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. Pokud rutina na nižší úrovni vyvolá výjimku, každá obslužná rutina výjimky nejvyšší úrovně v hierarchii zásobníku volání může číst a upravovat páry klíč/hodnota uložené v kolekci jinými obslužnými rutinami výjimek.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. To znamená, že je nutné zaručit, že informace v páru klíč/hodnota nejsou důvěrné a že vaše aplikace bude fungovat správně, pokud jsou informace v páru klíč/hodnota poškozeny.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.

Konflikty klíčůKey Conflicts

Ke konfliktu klíčů dojde, pokud různé obslužné rutiny výjimek určují stejný klíč pro přístup k páru klíč/hodnota.A key conflict occurs when different exception handlers specify the same key to access a key/value pair. Při vývoji aplikace buďte opatrní, protože v důsledku konfliktu klíčů je to, že obslužné rutiny výjimek nižší úrovně můžou nechtěně komunikovat s obslužnými rutinami vyšší úrovně a tato komunikace může způsobit drobné chyby programu.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. Pokud však dojde ke zvýšení opatrnosti, můžete použít klíčové konflikty k vylepšení aplikace.However, if you are cautious you can use key conflicts to enhance your application.

Předcházení konfliktům klíčůAvoiding Key Conflicts

Vyhněte se konfliktům klíčů tím, že přijmete zásady vytváření názvů pro generování jedinečných klíčů pro páry klíč/hodnota.Avoid key conflicts by adopting a naming convention to generate unique keys for key/value pairs. Konvence pojmenování může například vracet klíč, který se skládá z názvu vaší aplikace s oddělenými tečkami, metoda, která poskytuje doplňující informace pro dvojici a jedinečný identifikátor.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.

Předpokládejme, že dvě aplikace s názvem Products a dodavatelé mají metodu s názvem Sales.Suppose two applications, named Products and Suppliers, each has a method named Sales. Metoda Sales v aplikaci Products poskytuje identifikační číslo (skladové jednotky nebo SKU) produktu.The Sales method in the Products application provides the identification number (the stock keeping unit or SKU) of a product. Metoda Sales v aplikaci dodavatelé poskytuje identifikační číslo nebo identifikátor SID dodavatele.The Sales method in the Suppliers application provides the identification number, or SID, of a supplier. V důsledku toho konvence pojmenování pro tento příklad vrátí klíče "Products. Sales. SKU" a "Suppliers. Sales. SID".Consequently, the naming convention for this example yields the keys, "Products.Sales.SKU" and "Suppliers.Sales.SID".

Zneužití konfliktů klíčůExploiting Key Conflicts

Zneužití klíčového konfliktu pomocí přítomnosti jednoho nebo více speciálních předuspořádaných klíčů k řízení zpracování.Exploit key conflicts by using the presence of one or more special, prearranged keys to control processing. Předpokládejme, že v jednom scénáři obslužná rutina výjimky nejvyšší úrovně v hierarchii zásobníku volání zachytává všechny výjimky vyvolané obslužnými rutinami nižší úrovně.Suppose, in one scenario, the highest level exception handler in the call stack hierarchy catches all exceptions thrown by lower-level exception handlers. Pokud existuje dvojice klíč/hodnota se speciálním klíčem, obslužná rutina výjimky vysoké úrovně formátuje zbývající páry klíč/hodnota v IDictionary objektu nějakým nestandardním způsobem; v opačném případě jsou zbývající páry klíč/hodnota formátovány běžným způsobem.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.

Nyní předpokládejme, že v jiném scénáři obslužná rutina výjimky na každé úrovni hierarchie zásobníku volání zachytí výjimku vyvolanou další obslužnou rutinou výjimky nižší úrovně.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. Kromě toho každá obslužná rutina výjimky ví, že kolekce vrácená Data vlastností obsahuje sadu párů klíč/hodnota, které jsou k dispozici s předuspořádanou sadou klíčů.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.

Každá obslužná rutina výjimky používá předuspořádanou sadu klíčů k aktualizaci komponenty Value odpovídající dvojice klíč/hodnota s informacemi, které jsou jedinečné pro tuto obslužnou rutinu výjimky.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. Po dokončení procesu aktualizace vyvolá obslužná rutina výjimky výjimku z další obslužné rutiny výjimky vyšší úrovně.After the update process is complete, the exception handler throws the exception to the next higher-level exception handler. Nakonec obslužná rutina výjimky nejvyšší úrovně přistupuje k párů klíč/hodnota a zobrazí konsolidované informace o aktualizaci ze všech obslužných rutin výjimek nižší úrovně.Finally, the highest level exception handler accesses the key/value pairs and displays the consolidated update information from all the lower-level exception handlers.

Platí pro

Viz také