This topic has not yet been rated - Rate this topic

XmlReader.ReadAsync Method

.NET Framework 4.5

Asynchronously reads the next node from the stream.

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

'Declaration
Public Overridable Function ReadAsync As Task(Of Boolean)

Return Value

Type: System.Threading.Tasks.Task(Of Boolean)
true if the next node was read successfully; false if there are no more nodes to read.

Exceptions

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

Remarks

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

Version Information

.NET Framework

Supported in: 4.5

.NET for Windows Store apps

Supported in: Windows 8

Platforms

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.

Reference

XmlReader Class

System.Xml Namespace

Other Resources

Asynchronous Programming with Async and Await (C# and Visual Basic)

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)