This topic has not yet been rated - Rate this topic

XmlSerializer.Serialize Method (XmlWriter, Object, XmlSerializerNamespaces, String, String)

.NET Framework 4.5

Serializes the specified Object and writes the XML document to a file using the specified XmlWriter, XML namespaces, and encoding.

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

Syntax

C++

'Declaration
Public Sub Serialize ( _
	xmlWriter As XmlWriter, _
	o As Object, _
	namespaces As XmlSerializerNamespaces, _
	encodingStyle As String, _
	id As String _
)

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
An instance of the XmlSerializaerNamespaces that contains namespaces and prefixes to use.

encodingStyle: Type: System.String
The encoding used in the document.

id: Type: System.String
For SOAP encoded messages, the base used to generate id attributes.

Remarks

The id parameter supplies the base string used to create SOAP ids. By default, these are "id1", "id2" and so on. But if the parameter is set to "myBase" the generated values are "myBaseid1", "myBaseid2" and so on. This functionality is used to create unique id values across the whole SOAP message.

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

XmlSerializer Class

Serialize Overload

System.Xml.Serialization Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)