Article
11/18/2011

XmlSerializer.Serialize Method (Stream, Object)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Serializes the specified Object and writes the XML document to a file using the specified Stream.

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

Syntax

'Declaration
Public Sub Serialize ( _
    stream As Stream, _
    o As Object _
)

public void Serialize(
    Stream stream,
    Object o
)

Parameters

stream
Type: System.IO.Stream
The Stream used to write the XML document.

o
Type: System.Object
The Object to serialize.

Exceptions

Exception	Condition
InvalidOperationException	An error occurred during serialization. The original exception is available using the InnerException property.

Remarks

The Serialize method converts the public fields and read/write properties of an object into XML. It does not convert methods, indexers, private fields, or read-only properties. To serialize all of an object's fields and properties, both public and private, use the BinaryFormatter.

In the stream parameter, specify an object that derives from the abstract Stream class. Classes that derive from Stream include:

Note:
The XmlSerializer cannot serialize arrays of ArrayList and arrays of List<T>.

Platform Notes

Silverlight for Windows Phone

The XmlSerializer.Serialize method throws an InvalidOperationException if the XmlSerializer object is initialized with a type parameter that contains an array of objects of type XElement.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Partager via