SoapFormatter.Deserialize Method (Stream, HeaderHandler)

 
System_CAPS_noteNote

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

Deserializes the stream into an object graph with any headers in that stream being handled by the given HeaderHandler.

Namespace:   System.Runtime.Serialization.Formatters.Soap
Assembly:  System.Runtime.Serialization.Formatters.Soap (in System.Runtime.Serialization.Formatters.Soap.dll)

public object Deserialize(
	Stream serializationStream,
	HeaderHandler handler
)

Parameters

serializationStream
Type: System.IO.Stream

The stream that contains the data to deserialize.

handler
Type: System.Runtime.Remoting.Messaging.HeaderHandler

Delegate to handle any headers found on the stream. Can be null.

Return Value

Type: System.Object

The top object of the deserialized graph (root).

Exception Condition
ArgumentNullException

serializationStream is null.

SerializationException

serializationStream supports seeking, and its length is 0.

Headers are used only for specific remoting applications. The HeaderHandler parameter is one of two ways to return headers from a stream in SOAP Remote Procedure Call (RPC) format. The other way is to use the TopObject property.

For successful deserialization, the current position in the stream must be at the beginning of the object graph.

TimeSpan objects are serialized according to the ISO 8601: 1998 section 5.5.3.2.1 "Alternative" standard.

System_CAPS_security Security Note

Calling this method with untrusted data is a security risk. Call this method only with trusted data. For more information, see Untrusted Data Security Risks.

.NET Framework
Available since 1.1
Return to top
Show: