XmlSerializer.CanDeserialize(XmlReader) Method

Reference

Definition

Namespace:: System.Xml.Serialization

Assemblies:: System.Xml.dll, System.Xml.XmlSerializer.dll

Assemblies:: netstandard.dll, System.Xml.XmlSerializer.dll

Assembly:: System.Xml.XmlSerializer.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Source:: XmlSerializer.cs

Source:: XmlSerializer.cs

Source:: XmlSerializer.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a value that indicates whether this XmlSerializer can deserialize a specified XML document.

public:
 virtual bool CanDeserialize(System::Xml::XmlReader ^ xmlReader);

public virtual bool CanDeserialize(System.Xml.XmlReader xmlReader);

abstract member CanDeserialize : System.Xml.XmlReader -> bool
override this.CanDeserialize : System.Xml.XmlReader -> bool

Public Overridable Function CanDeserialize (xmlReader As XmlReader) As Boolean

Parameters

xmlReader: XmlReader

An XmlReader that points to the document to deserialize.

Returns

Boolean

true if this XmlSerializer can deserialize the object that the XmlReader points to; otherwise, false.

Examples

The following example calls the CanDeserialize method to check whether an XML document can be deserialized.

private:
   void TestDocument( String^ filename, Type^ objType )
   {
      // Using a FileStream, create an XmlTextReader.
      Stream^ fs = gcnew FileStream( filename,FileMode::Open );
      XmlReader^ reader = gcnew XmlTextReader( fs );
      XmlSerializer^ serializer = gcnew XmlSerializer( objType );
      if ( serializer->CanDeserialize( reader ) )
      {
         Object^ o = serializer->Deserialize( reader );
      }
      fs->Close();
   }

private void TestDocument(string filename, Type objType)
{
    // Using a FileStream, create an XmlTextReader.
    Stream fs = new FileStream(filename, FileMode.Open);
    XmlReader reader = new XmlTextReader(fs);
    XmlSerializer serializer = new XmlSerializer(objType);
    if (serializer.CanDeserialize(reader))
    {
        Object o = serializer.Deserialize(reader);
    }
    fs.Close();
}

Private Sub TestDocument _
                (ByVal filename As String, _
                 ByVal objType As Type)
    ' Using a FileStream, create an XmlTextReader.
    Dim fs As New FileStream(filename, FileMode.Open)
    Dim reader As New XmlTextReader(fs)
    Dim serializer As New XmlSerializer(objType)
    If serializer.CanDeserialize(reader) Then
        Dim o As Object = serializer.Deserialize(reader)
    End If
    fs.Close()
End Sub

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1
UWP	10.0

Share via