Why does C# XmlDocument.LoadXml(string) fail when an XML header is included?

by

Background

Although your question does have the encoding set as UTF-16, you don’t have the string properly escaped so I wasn’t sure if you did, in fact, accurately transpose the string into your question.

I ran into the same exception:

System.Xml.XmlException: Data at the
root level is invalid. Line 1,
position 1.

However, my code looked like this:

string xml = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<event>This is a Test</event>";
XmlDocument xmlDoc = new XmlDocument();
xmlDoc.LoadXml(xml);

The Problem

The problem is that strings are stored internally as UTF-16 in .NET however the encoding specified in the XML document header may be different. E.g.:

<?xml version="1.0" encoding="utf-8"?>

From the MSDN documentation for String here:

Each Unicode character in a string is
defined by a Unicode scalar value,
also called a Unicode code point or
the ordinal (numeric) value of the
Unicode character. Each code point is
encoded using UTF-16 encoding, and the
numeric value of each element of the
encoding is represented by a Char
object.

This means that when you pass XmlDocument.LoadXml() your string with an XML header, it must say the encoding is UTF-16. Otherwise, the actual underlying encoding won’t match the encoding reported in the header and will result in an XmlException being thrown.

The Solution

The solution for this problem is to make sure the encoding used in whatever you pass the Load or LoadXml method matches what you say it is in the XML header. In my example above, either change your XML header to state UTF-16 or to encode the input in UTF-8 and use one of the XmlDocument.Load methods.

Below is sample code demonstrating how to use a MemoryStream to build an XmlDocument using a string which defines a UTF-8 encode XML document (but of course, is stored a UTF-16 .NET string).

string xml = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<event>This is a Test</event>";

// Encode the XML string in a UTF-8 byte array
byte[] encodedString = Encoding.UTF8.GetBytes(xml);

// Put the byte array into a stream and rewind it to the beginning
MemoryStream ms = new MemoryStream(encodedString);
ms.Flush();
ms.Position = 0;

// Build the XmlDocument from the MemorySteam of UTF-8 encoded bytes
XmlDocument xmlDoc = new XmlDocument();
xmlDoc.Load(ms);

More Related Contents:

  1. Read XML Attribute using XmlDocument
  2. How to serialize/deserialize to `Dictionary` from custom XML not using XElement?
  3. Serializing private member data
  4. How would you compare two XML Documents?
  5. Query an XDocument for elements by name at any depth
  6. String escape into XML
  7. Serialize Property as Xml Attribute in Element
  8. .net XML Serialization – Storing Reference instead of Object Copy
  9. What is the difference between Linq to XML Descendants and Elements
  10. Serialize a nullable int
  11. how to use XPath with XDocument?
  12. How to prevent blank xmlns attributes in output from .NET’s XmlDocument?
  13. How to decode string to XML string in C#
  14. How to store data locally in .NET (C#) [closed]
  15. XmlSerializer – There was an error reflecting type
  16. Entity Framework with XML Files [closed]
  17. Read a XML (from a string) and get some fields – Problems reading XML
  18. Passing parameters to XSLT Stylesheet via .NET
  19. Error Deserializing Xml to Object – xmlns=” was not expected
  20. XmlTextReader vs. XDocument
  21. Removing nodes from an XmlDocument
  22. How to check for valid xml in string input before calling .LoadXml()
  23. Use the XmlInclude or SoapInclude attribute to specify types that are not known statically
  24. Data at the root level is invalid [duplicate]
  25. How to get xpath from an XmlNode instance
  26. Finding element in XDocument?
  27. How can I remove empty xmlns attribute from node created by XElement
  28. How do I return XML from a Stored Procedure?
  29. How can I convert a DataTable to an XML file in C#?
  30. Reading XML with an “&” into C# XMLDocument Object

Leave a Comment