Solved

XML Read Error: There is no Unicode byte order mark

Posted on 2013-10-29
10
1,563 Views
Last Modified: 2013-10-29
I'm trying to read an XML file that our customer will be sending us weekly.  I'm writing code to read it as below:
        Dim sWorkRequested As String
        Dim sPoNumber As String

        Dim m_xmld As XmlDocument
        Dim m_nodelist As XmlNodeList
        Dim m_node As XmlNode
        m_xmld = New XmlDocument

        m_xmld.Load("JobList.xml")    '<---Error occurs here

        m_nodelist = m_xmld.SelectNodes("/JobRequest")

        For Each m_node In m_nodelist
            sWorkRequested = m_node.Item("WorkRequested").InnerText
            sPoNumber = m_node.Item("PoNumber").InnerText

            Debug.Print("sWorkRequested" & sWorkRequested)
            Debug.Print("sPoNumber" & sPoNumber)
        Next

Open in new window


However I'm getting an error:
"There is no Unicode byte order mark"

Researching the issue, it seems like the first line of the XML
<?xml version="1.0" encoding="utf-16"?>
Should be
<?xml version="1.0">

However, I can't ask the customer to change, I need to take the encoding tag into account.

So, how do I do this within the code sample above?

TIA


Here's a sample of the XML file:
<?xml version="1.0" encoding="utf-16"?>
<JobRequest>
  <WorkRequested>Structural Analysis</WorkRequested>
  <PoNumber>POZ000000076219</PoNumber>
  <PoAmount>500</PoAmount>
</JobRequest>

Open in new window

0
Comment
Question by:Clif
  • 4
  • 4
  • 2
10 Comments
 
LVL 75

Expert Comment

by:käµfm³d 👽
ID: 39608740
Is this document really UTF-16 encoded? If so, then it needs byte order marks. Otherwise, you need to ask that the source application change the encoding type. Generally speaking, UTF-8 is probably what you're after.
0
 
LVL 10

Author Comment

by:Clif
ID: 39609018
If, just for grins & giggles, I take out the (encoding="utf-16") tag, the code reads the file correctly.
0
 
LVL 75

Expert Comment

by:käµfm³d 👽
ID: 39609123
Exactly. If you specify UTF-16 in your document, then byte order marks are required. Your document does not provide them, hence the error.
0
 
LVL 10

Author Comment

by:Clif
ID: 39609203
I understand the error, as I said in the OP, I have done some research.

The question is, how to resolve the error without asking the customer to change their file (the customer is always right)?

In my research, I've seem some suggestions at a solution, but they were either in C# or I did not understand what was being suggested.
0
 
LVL 62

Expert Comment

by:Fernando Soto
ID: 39609564
Can you ask the customer if they intended to send the XML file with the utf field marked with uft-16 when the file they are transmitting is not in that format. Maybe they are not aware that the file is being transmitted in the wrong format. If they say that they are aware of that and it is the way they wish of doing it then you can write code to open the file in text mode and change the utf-16 to utf-8 and save the file back to the file system and then process your XML file as normal.
0
Is Your Active Directory as Secure as You Think?

More than 75% of all records are compromised because of the loss or theft of a privileged credential. Experts have been exploring Active Directory infrastructure to identify key threats and establish best practices for keeping data safe. Attend this month’s webinar to learn more.

 
LVL 75

Expert Comment

by:käµfm³d 👽
ID: 39609576
If it works without it, then strip it out:

e.g.

Using buffer As New System.IO.StringWriter()
    Using reader As New System.IO.StreamReader("input.xml")
        Dim xmlDeclaration As String = reader.ReadLine()

        xmlDeclaration = xmlDeclaration.Replace("encoding=""utf-16""", String.Empty)

        buffer.WriteLine(xmlDeclaration)

        While Not reader.EndOfStream buffer.WriteLine(reader.ReadLine())
    End Using

    Dim moddedXml As String = buffer.ToString()
    Dim xdoc As New System.Xml.XmlDocument()

    xdoc.LoadXml(moddedXml)
End Using

Open in new window


From a design perspective, you are coding around bad data rather than fixing the bad data. If the user decides to properly encode the file at some point without telling you, then your new logic breaks.
0
 
LVL 10

Author Comment

by:Clif
ID: 39609614
FernandoSoto,
Unfortunately I cannot ask the customer to change their coding.  Apparently it works for their other vendors.



kaufmed,
Your code has an error (While not ended)

If it should be UTF-8, why not do this in your code:
xmlDeclaration = xmlDeclaration.Replace("encoding=""utf-16""", "encoding=""utf-8""")

Would that not solve the issue of it breaking should the customer suddenly decide to code it correctly?

I await your "fixed" code.
0
 
LVL 62

Expert Comment

by:Fernando Soto
ID: 39609668
Hi Clif;

My post was not asking you to tell the customer that they are doing it wrong but only to verify that the utf-16 is not matching what they are sending out. If they say this is what they want then all is good and fine, you have documentation of this is, it is called CYA. Otherwise just code around the badly formed XML document as I stated in my last post. Just remember as @kaufmed stated, if they correct the issues in the future that will break your code
0
 
LVL 75

Accepted Solution

by:
käµfm³d   👽 earned 500 total points
ID: 39609909
I had a feeling that line would break. (Too much C# on the brain, I suppose.) The While loop should be:

While Not reader.EndOfStream
    buffer.WriteLine(reader.ReadLine())
End While

Open in new window


If it should be UTF-8, why not do this in your code:
Well, you can, but do you know for a fact that it is encoded as UTF-8? (More than likely it is, so what were talking about here is really more of principle rather than procedure.) Whether you replace the "UTF-16" with an empty string or a "UTF-8" is probably inconsequential for the immediate need.
0
 
LVL 10

Author Closing Comment

by:Clif
ID: 39609973
It works.  I'll keep your concerns in mind.

Thanks.
0

Featured Post

Is Your Active Directory as Secure as You Think?

More than 75% of all records are compromised because of the loss or theft of a privileged credential. Experts have been exploring Active Directory infrastructure to identify key threats and establish best practices for keeping data safe. Attend this month’s webinar to learn more.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Well, all of us have seen the multiple EXCEL.EXE's in task manager that won't die even if you call the .close, .dispose methods. Try this method to kill any excels in memory. You can copy the kill function to create a check function and replace the …
Since .Net 2.0, Visual Basic has made it easy to create a splash screen and set it via the "Splash Screen" drop down in the Project Properties.  A splash screen set in this manner is automatically created, displayed and closed by the framework itsel…
With the power of JIRA, there's an unlimited number of ways you can customize it, use it and benefit from it. With that in mind, there's bound to be things that I wasn't able to cover in this course. With this summary we'll look at some places to go…
Many functions in Excel can make decisions. The most simple of these is the IF function: it returns a value depending on whether a condition you describe is true or false. Once you get the hang of using the IF function, you will find it easier to us…

912 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

17 Experts available now in Live!

Get 1:1 Help Now