Exception.SerializeObjectState Event
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Caution
BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.
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;[System.Obsolete("BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.", DiagnosticId="SYSLIB0011", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
protected event EventHandler<System.Runtime.Serialization.SafeSerializationEventArgs>? SerializeObjectState;protected event EventHandler<System.Runtime.Serialization.SafeSerializationEventArgs> SerializeObjectState;member this.SerializeObjectState : EventHandler<System.Runtime.Serialization.SafeSerializationEventArgs> [<System.Obsolete("BinaryFormatter serialization is obsolete and should not be used. See https://aka.ms/binaryformatter for more information.", DiagnosticId="SYSLIB0011", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>]
member this.SerializeObjectState : EventHandler<System.Runtime.Serialization.SafeSerializationEventArgs> Protected Custom Event SerializeObjectState As EventHandler(Of SafeSerializationEventArgs) Event Type
- Attributes
Remarks
The exception state object implements the ISafeSerializationData interface.
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. The CompleteDeserialization callback method of the exception state object is then notified so that it can push deserialized data into the empty exception.
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.
If the SerializeObjectState event is not subscribed to, deserialization occurs as usual using the Exception constructor.
Typically, a handler for the SerializeObjectState event is added in the exception's constructor to provide for its serialization. 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. 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.
Notes to Inheritors
If this event is subscribed to and used, all derived types that follow in the inheritance hierarchy must implement the same serialization mechanism.
