XDocument.WriteToAsync(XmlWriter, CancellationToken) Method

Definition

Writes this XDocument's underlying XML tree to the specified XmlWriter.

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

Parameters

writer
XmlWriter

The writer to output the content of this XDocument.

cancellationToken
CancellationToken

A cancellation token.

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