Export (0) Print
Expand All

XmlConvert.VerifyXmlChars Method

Returns the passed-in string if all the characters and surrogate pair characters in the string argument are valid XML characters, otherwise an XmlException is thrown with information on the first invalid character encountered.

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

public static string VerifyXmlChars(
	string content
)

Parameters

content
Type: System.String

String that contains characters to verify.

Return Value

Type: System.String
Returns the passed-in string if all the characters and surrogate-pair characters in the string argument are valid XML characters, otherwise an XmlException is thrown with information on the first invalid character encountered.

No other values than the passed in argument should be returned. See XML 1.0 spec (fourth edition) production [2] Char for details on the allowed characters.

If the parameter is null, an ArgumentNullException will be thrown. If any of the characters are not valid xml characters, an XmlException is thrown with information on the first invalid character encountered.

The following example uses the VerifyXmlChars method used to detect an illegal character in the start element.

            XmlTextWriter writer3 = new XmlTextWriter("outFile.xml", null);
            char illegalChar = '\uFFFE';
            string charsToVerify = "Test String "; 

            try
            {
                // Write the root element.
                writer3.WriteStartElement("root");

                // Throw an exception due illegal character.
                writer3.WriteStartElement(
                    XmlConvert.VerifyXmlChars(charsToVerify + illegalChar));

                writer3.WriteString("ValueText");
                writer3.WriteEndElement();

                // Write the end tag for the root element.
                writer3.WriteEndElement();

                writer3.Close();

            }
            catch (XmlException e)
            {
                Console.WriteLine(e.Message);
                writer3.Close();
            }

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft