Export (0) Print
Expand All

XmlSerializer::Deserialize Method (XmlReader)

Deserializes the XML document contained by the specified XmlReader.

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

public:
Object^ Deserialize(
	XmlReader^ xmlReader
)

Parameters

xmlReader
Type: System.Xml::XmlReader
The XmlReader that contains the XML document to deserialize.

Return Value

Type: System::Object
The Object being deserialized.

ExceptionCondition
InvalidOperationException

An error occurred during deserialization. The original exception is available using the InnerException property.

Deserialization is the process of reading an instance of 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.

The XmlReader automatically detects and uses the encoding specified by the XML document.

NoteNote

The XmlSerializer cannot deserialize the following: arrays of ArrayList and arrays of List<T>.

The following example deserializes an object using an XmlReader.


#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Text;
using namespace System::Xml;
using namespace System::Xml::Serialization;

// This is the class that will be deserialized.
public ref class OrderedItem
{
public:
   String^ ItemName;
   String^ Description;
   Decimal UnitPrice;
   int Quantity;
   Decimal LineTotal;

   // A custom method used to calculate price per item.
   void Calculate()
   {
      LineTotal = UnitPrice * Quantity;
   }
};

void DeserializeObject( String^ filename )
{
   Console::WriteLine( "Reading with XmlReader" );

   // Create an instance of the XmlSerializer specifying type and namespace.
   XmlSerializer^ serializer = gcnew XmlSerializer( OrderedItem::typeid );

   // A FileStream is needed to read the XML document.
   FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
   XmlReader^ reader = gcnew XmlTextReader( fs );

   // Declare an object variable of the type to be deserialized.
   OrderedItem^ i;

   // Use the Deserialize method to restore the object's state.
   i = dynamic_cast<OrderedItem^>(serializer->Deserialize( reader ));

   // Write out the properties of the object.
   Console::Write( "{0}\t{1}\t{2}\t{3}\t{4}", i->ItemName, i->Description, i->UnitPrice, i->Quantity, i->LineTotal );
}

int main()
{
   // Read a purchase order.
   DeserializeObject( "simple.xml" );
}



<?xml version="1.0"?>
 <OrderedItem xmlns:inventory="http://www.cpandl.com" xmlns:money="http://www.cohowinery.com">
   <inventory:ItemName>Widget</inventory:ItemName>
   <inventory:Description>Regular Widget</inventory:Description>
   <money:UnitPrice>2.3</money:UnitPrice>
   <inventory:Quantity>10</inventory:Quantity>
   <money:LineTotal>23</money:LineTotal>
 </OrderedItem>



.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.

Community Additions

ADD
Show:
© 2014 Microsoft