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)
Parameters
- name
- Type: System.String
The name to check.
Return Value
Type: System.StringThe text contained in the element that was read. An empty string if the element is empty (<item></item> or <item/>).
| Exception | Condition |
|---|---|
| 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. |
| InvalidOperationException | An XmlReader method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message “An asynchronous operation is already in progress.” |
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.
For the asynchronous version of this method, see ReadElementStringAsync.
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.
