Erro criando mensagem com XmlDocument: An error occurred while parsing EntityName.

Quem nunca precisou montar mensagens com a classe XmlDocument? Sempre lembrando que essa classe é recomendada apenas quando a mensagem for pequena, pois é completamente carregada na memória. Então para enviar uma mensagem de erro, um email, um arquivo de retorno, essa classe pode ser usada.

Pensando em tratar mensagem de erros, quando adicionamos um shape do tipo Scope e adicionamos o Exception Handler, estamos prontos para pegar a descrição dos erros que podem vir a acontecer, adicionando o shape Message Assignment. E então colocamos um código parecido com esse abaixo:

Assim, na hora de executar esse construct, gera o seguinte erro:

Inner exception: An error occurred while parsing EntityName. Line 14, position 75.
       
Exception type: XmlException
Source: System.Xml

Causa:

A váriavel que está trazendo a descrição do erro, err.ErrorDescription, provavelmente tem caracteres próprios de XML, como: <, >.

Resolução:

Para resolver, basta colocar o valor do campo entre a tag CDATA, pois tudo o que estiver dentro dessa tag será ignorado pelo Parser. Segue:

<![CDATA[ o seu texto aqui ]]>

Aqui o resultado dessa construção e sem erros:

É isso, fica documentado!

Até a próxima.