This documentation is archived and is not being maintained.

XmlSerializer.Deserialize Method (Stream)

Deserializes the XML document contained by the specified Stream.

Namespace:  System.Xml.Serialization
Assembly:  System.Xml (in System.Xml.dll)

Public Function Deserialize ( _
	stream As Stream _
) As Object


Type: System.IO.Stream
The Stream that contains the XML document to deserialize.

Return Value

Type: System.Object
The Object being deserialized.

Deserialization is the process of reading an XML document and constructing an object that is strongly typed to the XML Schema (XSD) of the document.

Before deserializing, an XmlSerializer must be constructed using the type of the object that is being deserialized.

Use the stream parameter to specify an object that derives from the Stream class, which is designed to write to streams. Classes that derive from the Stream class include:


The XmlSerializer cannot deserialize the following: arrays of ArrayList and arrays of List(Of T).

The following example deserializes an object using a Stream object.

Imports System
Imports System.IO
Imports System.Xml.Serialization
Imports Microsoft.VisualBasic

' This is the class that will be deserialized.
Public Class OrderedItem
    <XmlElement(Namespace := "")> _
    Public ItemName As String

    <XmlElement(Namespace := "")> _
    Public Description As String

    <XmlElement(Namespace := "")> _
    Public UnitPrice As Decimal

    <XmlElement(Namespace := "")> _
    Public Quantity As Integer

    <XmlElement(Namespace := "")> _
    Public LineTotal As Decimal

    'A custom method used to calculate price per item.
    Public Sub Calculate()
        LineTotal = UnitPrice * Quantity
    End Sub
End Class

Public Class Test

    Public Shared Sub Main()
        Dim t As New Test()
        ' Read a purchase order.
    End Sub

    Private Sub DeserializeObject(ByVal filename As String)
        Console.WriteLine("Reading with Stream")
        ' Create an instance of the XmlSerializer.
        Dim serializer As New XmlSerializer(GetType(OrderedItem))
        ' Reading the XML document requires a FileStream.
        Dim reader As New FileStream(filename, FileMode.Open)

        ' Declare an object variable of the type to be deserialized.
        Dim i As OrderedItem

        ' Call the Deserialize method to restore the object's state.
        i = CType(serializer.Deserialize(reader), OrderedItem)

        ' Write out the properties of the object.
        Console.Write(i.ItemName & ControlChars.Tab & _
                      i.Description & ControlChars.Tab & _
                      i.UnitPrice & ControlChars.Tab & _
                      i.Quantity & ControlChars.Tab & _
    End Sub
End Class

<?xml version="1.0"?>
 <OrderedItem xmlns:inventory="" xmlns:money="">
   <inventory:Description>Regular Widget</inventory:Description>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.