This documentation is archived and is not being maintained.

XmlReader.ReadElementString Method (String, String)

Checks that the LocalName and NamespaceURI properties of the element found matches the given strings before reading a text-only element.

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

public virtual string ReadElementString(
	string localname,
	string ns
)

Parameters

localname
Type: System.String

The local name to check.

ns
Type: System.String

The namespace URI to check.

Return Value

Type: System.String
The text contained in the element that was read. An empty string if the element is empty (<item></item> or <item/>).

ExceptionCondition
XmlException

If the next content node is not a start tag; if the element LocalName or NamespaceURI do not match the given arguments; or if the element found does not contain a simple text value.

This is a helper method for reading simple text-only elements. It calls MoveToContent to find the next content node and then parses its value as a simple string.

Using the XML, <name>Arlene Huff</name>, ReadElementString consumes the element and returns the string Arlene Huff.

This method cannot handle any markup (child elements, comments, processing instructions, and so on) inside the name element, but it can concatenate multiple adjacent text and CDATA blocks.

After calling this method the reader will be positioned on the node following the EndElement node or after the empty element tag.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: