Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

XmlReader.ReadElementString Method (String)

Checks that the Name property of the element found matches the given string before reading a text-only element.

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

public virtual string ReadElementString (
	string name
)
public String ReadElementString (
	String name
)
public function ReadElementString (
	name : String
) : String

Parameters

name

The name to check.

Return Value

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

Exception typeCondition

XmlException

If the next content node is not a start tag; if the element Name does not match the given argument; 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 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft