XmlSerializer::Serialize Method (XmlWriter^, Object^, XmlSerializerNamespaces^, String^)

 

Serializes the specified object and writes the XML document to a file using the specified XmlWriter and references the specified namespaces and encoding style.

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

public:
void Serialize(
	XmlWriter^ xmlWriter,
	Object^ o,
	XmlSerializerNamespaces^ namespaces,
	String^ encodingStyle
)

Parameters

xmlWriter
Type: System.Xml::XmlWriter^

The XmlWriter used to write the XML document.

o
Type: System::Object^

The object to serialize.

namespaces
Type: System.Xml.Serialization::XmlSerializerNamespaces^

The XmlSerializerNamespaces referenced by the object.

encodingStyle
Type: System::String^

The encoding style of the serialized XML.

Exception Condition
InvalidOperationException

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

When the Serialize method is invoked, the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. To serialize all fields and properties, both public and private, use the BinaryFormatter.

Use the xmlWriter parameter to specify an object that derives from the abstract XmlWriter class, which is designed to write XML documents. The XmlTextWriter derives from the XmlWriter.

Set the encodingStyle parameter to "http://schemas.xmlsoap.org/soap/encoding/" for SOAP version 1.1 encoding; otherwise, set it to "http://www.w3.org/2001/12/soap-encoding" for SOAP version 1.2 encoding.

System_CAPS_noteNote

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

.NET Framework
Available since 2.0
Return to top
Show: