XElement.SaveAsync Method

Definition

Namespace:

System.Xml.Linq

Assembly:

System.Xml.XDocument.dll

Overloads

SaveAsync(Stream, SaveOptions, CancellationToken)	Asynchronously outputs this XElement to a Stream.
SaveAsync(XmlWriter, CancellationToken)	Asynchronously outputs this XElement to an XmlWriter.
SaveAsync(TextWriter, SaveOptions, CancellationToken)	Asynchronously outputs this XElement to a TextWriter.

SaveAsync(Stream, SaveOptions, CancellationToken)

Source:

XElement.cs

Asynchronously outputs this XElement to a Stream.

public:
 System::Threading::Tasks::Task ^ SaveAsync(System::IO::Stream ^ stream, System::Xml::Linq::SaveOptions options, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task SaveAsync (System.IO.Stream stream, System.Xml.Linq.SaveOptions options, System.Threading.CancellationToken cancellationToken);

member this.SaveAsync : System.IO.Stream * System.Xml.Linq.SaveOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SaveAsync (stream As Stream, options As SaveOptions, cancellationToken As CancellationToken) As Task

Parameters

stream

Stream

The stream to output the XML to.

options

SaveOptions

A bitwise combination of the enumeration values that specify the serialization options.

cancellationToken

CancellationToken

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

Returns

Task

A task representing the asynchronous save operation.

Exceptions

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 Save(Stream, SaveOptions).

SaveAsync(XmlWriter, CancellationToken)

Source:

XElement.cs

Asynchronously outputs this XElement to an XmlWriter.

public:
 System::Threading::Tasks::Task ^ SaveAsync(System::Xml::XmlWriter ^ writer, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task SaveAsync (System.Xml.XmlWriter writer, System.Threading.CancellationToken cancellationToken);

member this.SaveAsync : System.Xml.XmlWriter * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SaveAsync (writer As XmlWriter, cancellationToken As CancellationToken) As Task

Parameters

writer

XmlWriter

The writer to output the XML to.

cancellationToken

CancellationToken

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

Returns

Task

A task representing the asynchronous save operation.

Exceptions

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

SaveAsync(TextWriter, SaveOptions, CancellationToken)

Source:

XElement.cs

Asynchronously outputs this XElement to a TextWriter.

public:
 System::Threading::Tasks::Task ^ SaveAsync(System::IO::TextWriter ^ textWriter, System::Xml::Linq::SaveOptions options, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task SaveAsync (System.IO.TextWriter textWriter, System.Xml.Linq.SaveOptions options, System.Threading.CancellationToken cancellationToken);

member this.SaveAsync : System.IO.TextWriter * System.Xml.Linq.SaveOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SaveAsync (textWriter As TextWriter, options As SaveOptions, cancellationToken As CancellationToken) As Task

Parameters

textWriter

TextWriter

The writer to output the XML to.

options

SaveOptions

A bitwise combination of the enumeration values that specify the serialization options.

cancellationToken

CancellationToken

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

Returns

Task

A task representing the asynchronous save operation.

Exceptions

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 Save(TextWriter, SaveOptions).