XNode.ReadFromAsync(XmlReader, CancellationToken) Method

Definition

Namespace:

System.Xml.Linq

Assembly:

System.Xml.XDocument.dll

Source:

XNode.cs

Creates an XNode from an XmlReader. The runtime type of the node is determined by the NodeType of the first node encountered in the reader.

public:
 static System::Threading::Tasks::Task<System::Xml::Linq::XNode ^> ^ ReadFromAsync(System::Xml::XmlReader ^ reader, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task<System.Xml.Linq.XNode> ReadFromAsync (System.Xml.XmlReader reader, System.Threading.CancellationToken cancellationToken);

static member ReadFromAsync : System.Xml.XmlReader * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Xml.Linq.XNode>

Public Shared Function ReadFromAsync (reader As XmlReader, cancellationToken As CancellationToken) As Task(Of XNode)

Parameters

reader

XmlReader

A reader positioned at the node to read into this XNode.

cancellationToken

CancellationToken

A token that can be used to request cancellation of the asynchronous operation.

Returns

Task<XNode>

An XNode that contains the nodes read from the reader.

Exceptions

InvalidOperationException

The XmlReader is not positioned on a recognized node type.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ReadFrom(XmlReader).