XElement.SaveAsync Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
| SaveAsync(Stream, SaveOptions, CancellationToken) | |
| SaveAsync(XmlWriter, CancellationToken) | |
| SaveAsync(TextWriter, SaveOptions, CancellationToken) |
Asynchronously outputs this XElement to a TextWriter. |
- Source:
- XElement.cs
- Source:
- XElement.cs
- Source:
- XElement.cs
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.TaskPublic Function SaveAsync (stream As Stream, options As SaveOptions, cancellationToken As CancellationToken) As TaskParameters
- 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
A task representing the asynchronous save 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 Save(Stream, SaveOptions).
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Standard | 2.1 |
- Source:
- XElement.cs
- Source:
- XElement.cs
- Source:
- XElement.cs
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.TaskPublic Function SaveAsync (writer As XmlWriter, cancellationToken As CancellationToken) As TaskParameters
- 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
A task representing the asynchronous save 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 Save(XmlWriter).
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Standard | 2.1 |
- Source:
- XElement.cs
- Source:
- XElement.cs
- 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.TaskPublic Function SaveAsync (textWriter As TextWriter, options As SaveOptions, cancellationToken As CancellationToken) As TaskParameters
- 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
A task representing the asynchronous save 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 Save(TextWriter, SaveOptions).
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Standard | 2.1 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: