Edit

Share via

XmlReader.ReadToFollowing Method

Definition

Namespace:
System.Xml
Assemblies:
System.Xml.dll, System.Xml.ReaderWriter.dll
Assemblies:
netstandard.dll, System.Xml.ReaderWriter.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll

Reads until the named element is found.

Overloads

ReadToFollowing(String)

Reads until an element with the specified qualified name is found.
ReadToFollowing(String, String)

Reads until an element with the specified local name and namespace URI is found.

ReadToFollowing(String)

Source:
XmlReader.cs
Source:
XmlReader.cs
Source:
XmlReader.cs
Source:
XmlReader.cs

Reads until an element with the specified qualified name is found.

public virtual bool ReadToFollowing(string name);

Parameters

name
String

The qualified name of the element.

Returns

Boolean

true if a matching element is found; otherwise false and the XmlReader is in an end of file state.

Exceptions

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."

ArgumentException

The parameter is an empty string.

Remarks

This method is functionally equivalent executing the following::name XPath expression from the current node. It provides a quick way to find a named element in the XML document. It advances the reader to the next following element that matches the specified name and returns true if a matching element is found. Using the example below, the reader would read to the first instance of the specified element while reading forward.

<!--"sample.xml"-->
<?xml version="1.0">
   <items>
      <item xmls="urn:1"/>
   </items>
</xml>

XmlTextReader reader = newXmlTextReader("sample.xml");

reader.ReadToFollowing("item");

This method can be called on all node types.

Applies to

.NET 10 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

ReadToFollowing(String, String)

Source:
XmlReader.cs
Source:
XmlReader.cs
Source:
XmlReader.cs
Source:
XmlReader.cs

Reads until an element with the specified local name and namespace URI is found.

public virtual bool ReadToFollowing(string localName, string namespaceURI);

Parameters

localName
String

The local name of the element.

namespaceURI
String

The namespace URI of the element.

Returns

Boolean

true if a matching element is found; otherwise false and the XmlReader is in an end of file state.

Exceptions

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."

ArgumentNullException

Both parameter values are null.

Remarks

This method is functionally equivalent executing the following::name XPath expression from the current node. It provides a quick way to find a named element in the XML document. It advances the reader to the next following element that matches the specified name and returns true if a matching element is found.

<!--"sample.xml"-->
<?xml version="1.0">
   <items>
      <item xmls="urn:1"/>
   </items>
</xml>

XmlTextReader reader = newXmlTextReader("sample.xml");

reader.ReadToFollowing("item", "urn:1");

This method can be called on all node types.

Applies to

.NET 10 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0