Exception::SerializeObjectState Event

.NET Framework (current version)

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

event EventHandler<SafeSerializationEventArgs^>^ SerializeObjectState {
	void add(EventHandler<SafeSerializationEventArgs^>^ value);
	void remove(EventHandler<SafeSerializationEventArgs^>^ value);

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 Implementers:

If this event is subscribed to and used, all derived types that follow in the inheritance hierarchy must implement the same serialization mechanism.

The following example defines a BadDivisionException that handles the SerializeObjectState event. It also contains a state object, which is a nested structure named BadDivisionExceptionState that implements the ISafeSerializationData interface.

No code example is currently available or this language may not be supported.

The BadDivisionException exception is thrown when a floating-point division by zero occurs. 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. 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.

.NET Framework
Available since 4.0
Return to top