XNode.WriteToAsync(XmlWriter, CancellationToken) Method

Definition

Writes the current node to an XmlWriter.

public:
 abstract System::Threading::Tasks::Task ^ WriteToAsync(System::Xml::XmlWriter ^ writer, System::Threading::CancellationToken cancellationToken);
public abstract System.Threading.Tasks.Task WriteToAsync (System.Xml.XmlWriter writer, System.Threading.CancellationToken cancellationToken);
abstract member WriteToAsync : System.Xml.XmlWriter * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public MustOverride Function WriteToAsync (writer As XmlWriter, cancellationToken As CancellationToken) As Task

Parameters

writer
XmlWriter

The writer to write the current node into.

cancellationToken
CancellationToken

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

Returns

A task representing the asynchronous write operation.

Exceptions

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 WriteTo(XmlWriter).

Applies to