Exception.SerializeObjectState Exception.SerializeObjectState Exception.SerializeObjectState Exception.SerializeObjectState Event

Определение

Возникает, когда исключение сериализовано для создания объекта состояния исключения, содержащего сериализованные данные об исключении.Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

protected:
 event EventHandler<System::Runtime::Serialization::SafeSerializationEventArgs ^> ^ SerializeObjectState;
protected event EventHandler<System.Runtime.Serialization.SafeSerializationEventArgs> SerializeObjectState;
member this.SerializeObjectState : EventHandler<System.Runtime.Serialization.SafeSerializationEventArgs> 
Protected Custom Event SerializeObjectState As EventHandler(Of SafeSerializationEventArgs) 

Примеры

В следующем примере определяется объект BadDivisionException , SerializeObjectState обрабатывающий событие.The following example defines a BadDivisionException that handles the SerializeObjectState event. Он также содержит объект состояния, который является вложенной структурой с BadDivisionExceptionState именем, ISafeSerializationData реализующей интерфейс.It also contains a state object, which is a nested structure named BadDivisionExceptionState that implements the ISafeSerializationData interface.

using System;
using System.IO;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Formatters.Binary;

public class Example
{
   public static void Main()
   {
      bool serialized = false;
      var formatter = new BinaryFormatter();
      Double[] values = { 3, 2, 1 };
      Double divisor = 0;
      foreach (var value in values) {
         try {
            BadDivisionException ex = null;
            if (divisor == 0) { 
               if (! serialized) {
                  // Instantiate the exception object.
                  ex = new BadDivisionException(0);
                  // Serialize the exception object.
                  var fs = new FileStream("BadDivision1.dat", 
                                           FileMode.Create);
                  formatter.Serialize(fs, ex);
                  fs.Close();
                  Console.WriteLine("Serialized the exception...");
               }
               else {
                  // Deserialize the exception.
                  var fs = new FileStream("BadDivision1.dat",
                                           FileMode.Open);
                  ex = (BadDivisionException) formatter.Deserialize(fs);
                  // Reserialize the exception.
                  fs.Position = 0;
                  formatter.Serialize(fs, ex);
                  fs.Close();
                  Console.WriteLine("Reserialized the exception...");                                            
               }   
              throw ex; 
            } 
            Console.WriteLine("{0} / {1} = {1}", value, divisor, value/divisor);
         }   
         catch (BadDivisionException e) {
            Console.WriteLine("Bad divisor from a {0} exception: {1}",
                              serialized ? "deserialized" : "new", e.Divisor);             
            serialized = true;
         }   
      }
   }
}

[Serializable] public class BadDivisionException : Exception
{
   // Maintain an internal BadDivisionException state object.
   [NonSerialized] private BadDivisionExceptionState state = new BadDivisionExceptionState();

   public BadDivisionException(Double divisor)
   {
      state.Divisor = divisor;
      HandleSerialization();      
   }
   
   private void HandleSerialization()
   {
      SerializeObjectState += delegate(object exception, SafeSerializationEventArgs eventArgs) 
                                      { 
                                          eventArgs.AddSerializedState(state);
                                      };
   }
   
   public Double Divisor
   { get { return state.Divisor; } }

   [Serializable] private struct BadDivisionExceptionState : ISafeSerializationData 
   {
      private Double badDivisor;
      
      public Double Divisor
      { get { return badDivisor; } 
        set { badDivisor = value; } }

      void ISafeSerializationData.CompleteDeserialization(object deserialized)
      { 
         var ex = deserialized as BadDivisionException;
         ex.HandleSerialization();
         ex.state = this; 
      }
   }
}
// The example displays the following output:
//       Serialized the exception...
//       Bad divisor from a new exception: 0
//       Reserialized the exception...
//       Bad divisor from a deserialized exception: 0
//       Reserialized the exception...
//       Bad divisor from a deserialized exception: 0
Imports System.IO
Imports System.Runtime.Serialization
Imports System.Runtime.Serialization.Formatters.Binary
           
Module Example
   Public Sub Main()
      Dim serialized As Boolean = False
      Dim formatter As New BinaryFormatter()
      Dim values() As Double = { 3, 2, 1 }
      Dim divisor As Double = 0
      For Each value In values
         Try
            Dim ex As BadDivisionException = Nothing
            If divisor = 0 Then 
               If Not serialized Then
                  ' Instantiate the exception object.
                  ex = New BadDivisionException(0)
                  ' Serialize the exception object.
                  Dim fs As New FileStream("BadDivision1.dat", 
                                           FileMode.Create)
                  formatter.Serialize(fs, ex)
                  fs.Close()
                  Console.WriteLine("Serialized the exception...")
               Else
                  ' Deserialize the exception.
                  Dim fs As New FileStream("BadDivision1.dat",
                                           FileMode.Open)
                  ex = CType(formatter.Deserialize(fs), BadDivisionException)
                  ' Reserialize the exception.
                  fs.Position = 0
                  formatter.Serialize(fs, ex)
                  fs.Close()
                  Console.WriteLine("Reserialized the exception...")                                            
               End If   
              Throw ex 
            End If 
            Console.WriteLine("{0} / {1} = {1}", value, divisor, value/divisor)
         Catch e As BadDivisionException
            Console.WriteLine("Bad divisor from a {0} exception: {1}",
                              If(serialized, "deserialized", "new"), e.Divisor)             
            serialized = True
         End Try   
      Next
   End Sub
End Module

<Serializable> Public Class BadDivisionException : Inherits Exception
   ' Maintain an internal BadDivisionException state object.
   <NonSerialized> Private state As New BadDivisionExceptionState()

   Public Sub New(divisor As Double)
      state.Divisor = divisor
      HandleSerialization()      
   End Sub
   
   Private Sub HandleSerialization()
      AddHandler SerializeObjectState, 
                 Sub(exception As Object, eventArgs As SafeSerializationEventArgs)
                    eventArgs.AddSerializedState(state)
                 End Sub
   End Sub
   
   Public ReadOnly Property Divisor As Double
      Get
         Return state.Divisor
      End Get      
   End Property

   <Serializable> Private Structure BadDivisionExceptionState 
                                    Implements ISafeSerializationData
      private badDivisor As Double
      
      Public Property Divisor As Double
         Get
            Return badDivisor
         End Get
         Set
            badDivisor = value
         End Set
      End Property 

      Sub CompleteDeserialization(deserialized As Object) _
            Implements ISafeSerializationData.CompleteDeserialization
         Dim ex As BadDivisionException = TryCast(deserialized, BadDivisionException)
         ex.HandleSerialization()
         ex.state = Me 
      End Sub
   End Structure
End Class
' The example displays the following output:
'       Serialized the exception...
'       Bad divisor from a new exception: 0
'       Reserialized the exception...
'       Bad divisor from a deserialized exception: 0
'       Reserialized the exception...
'       Bad divisor from a deserialized exception: 0

BadDivisionException Исключение возникает при возникновении деления на ноль с плавающей запятой.The BadDivisionException exception is thrown when a floating-point division by zero occurs. Во время первого деления на ноль в примере создается BadDivisionException объект, сериализуется и создается исключение.During the first division by zero, the example instantiates a BadDivisionException object, serializes it, and throws the exception. При последующих делениях на ноль в примере выполняется десериализация ранее сериализованного объекта, повторная сериализация и исключение.When subsequent divisions by zero occur, the example deserializes the previously serialized object, reserializes it, and throws the exception. Чтобы обеспечить сериализацию объектов, десериализацию, сериализацию и десериализацию, в примере добавляется SerializeObjectState обработчик событий как BadDivisionException в конструкторе ISafeSerializationData.CompleteDeserialization класса, так и в реализации.To provide for object serialization, deserialization, reserialization, and deserialization, the example adds the SerializeObjectState event handler both in the BadDivisionException class constructor and in the ISafeSerializationData.CompleteDeserialization implementation.

Комментарии

Объект состояния исключения реализует ISafeSerializationData интерфейс.The exception state object implements the ISafeSerializationData interface.

SerializeObjectState Когда событие подписано на, исключение десериализуется и создается как пустое исключение.When the SerializeObjectState event is subscribed to, the exception is deserialized and created as an empty exception. Конструктор исключения не выполняется, и состояние исключения также десериализуется.The exception's constructor is not run, and the exception state is also deserialized. Затем CompleteDeserialization метод обратного вызова объекта состояния исключения получает уведомление, чтобы он мог отправить десериализованные данные в пустое исключение.The CompleteDeserialization callback method of the exception state object is then notified so that it can push deserialized data into the empty exception.

SerializeObjectState Событие включает прозрачные типы исключений для сериализации и десериализации данных исключений.The SerializeObjectState event enables transparent exception types to serialize and deserialize exception data. Прозрачный код может выполнять команды внутри границ набора разрешений, в котором он работает, но не может выполнять, вызывать, наследовать от или содержать критически важный код.Transparent code can execute commands within the bounds of the permission set it is operating within, but cannot execute, call, derive from, or contain critical code.

Если событие не подписано на, то десериализация выполняется как обычно Exception с помощью конструктора. SerializeObjectStateIf the SerializeObjectState event is not subscribed to, deserialization occurs as usual using the Exception constructor.

Как правило, обработчик SerializeObjectState события добавляется в конструктор исключения для предоставления его сериализации.Typically, a handler for the SerializeObjectState event is added in the exception's constructor to provide for its serialization. Но поскольку конструктор не выполняется при SerializeObjectState выполнении обработчика событий, сериализация десериализованного исключения может SerializationException вызвать исключение при попытке десериализовать исключение.But because the constructor is not executed when the SerializeObjectState event handler executes, serializing a deserialized exception can throw a SerializationException exception when you try to deserialize the exception. Чтобы избежать этого, следует также добавить обработчик для SerializeObjectState события ISafeSerializationData.CompleteDeserialization в методе.To avoid this, you should also add the handler for the SerializeObjectState event in the ISafeSerializationData.CompleteDeserialization method. Иллюстрации см. в разделе "примеры".See the Examples section for an illustration.

Примечания для тех, кто наследует этот метод

Если это событие подписано и используется, все производные типы, следующие за иерархией наследования, должны реализовывать тот же механизм сериализации.If this event is subscribed to and used, all derived types that follow in the inheritance hierarchy must implement the same serialization mechanism.

Применяется к