IXmlSerializable.GetSchema Method (System.Xml.Serialization)

.NET Framework Class Library

IXmlSerializable..::.GetSchema Method

This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return nullNothingnullptra null reference (Nothing in Visual Basic) (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.

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

Syntax

Function GetSchema As XmlSchema

XmlSchema GetSchema()

XmlSchema^ GetSchema()

abstract GetSchema : unit -> XmlSchema

Return Value

Type: System.Xml.Schema..::.XmlSchema
An XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method.

Remarks

When serializing or deserializing an object, the XmlSerializer class does not perform XML validation. For this reason, it is often safe to omit schema information by providing a trivial implementation of this method, for example by returning nullNothingnullptra null reference (Nothing in Visual Basic) (Nothing in Visual Basic).

If providing schema information is necessary, you should use the XmlSchemaProviderAttribute attribute. The GetSchema method should still return nullNothingnullptra null reference (Nothing in Visual Basic) (or Nothing).

Some .NET Framework types as well as legacy custom types implementing the IXmlSerializable interface may be using GetSchema instead of XmlSchemaProvider. In this case, the method returns an accurate XML schema that describes the XML representation of the object generated by the WriteXml()()() method.

Version Information

.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

Platforms

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.

Reference

IXmlSerializable Interface

System.Xml.Serialization Namespace

Advertise Here