XmlReader.ReadAsync Method ()

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Asynchronously reads the next node from the stream.

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

C#
C++
F#
VB
Copy 
public virtual Task<bool> ReadAsync()

Return Value

Type: System.Threading.Tasks.Task<Boolean>

true if the next node was read successfully; false if there are no more nodes to read.

Exception Condition
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.”

InvalidOperationException

An XmlReader asynchronous method was called without setting the Async flag to true. In this case, InvalidOperationException is thrown with the message “Set XmlReaderSettings.Async to true if you want to use Async Methods.”

This is the asynchronous version of Read, with the same functionality. To use this method, you must set the Async flag to true.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: