XDocument.SaveAsync Method
Definition
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.
Overloads
| SaveAsync(XmlWriter, CancellationToken) | |
| SaveAsync(Stream, SaveOptions, CancellationToken) | |
| SaveAsync(TextWriter, SaveOptions, CancellationToken) |
Writes this XDocument to a TextWriter. |
SaveAsync(XmlWriter, CancellationToken)
- Source:
- XDocument.cs
- Source:
- XDocument.cs
- Source:
- XDocument.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 cancellation token.
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
SaveAsync(Stream, SaveOptions, CancellationToken)
- Source:
- XDocument.cs
- Source:
- XDocument.cs
- Source:
- XDocument.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 write the XML to.
- options
- SaveOptions
A set of load options.
- cancellationToken
- CancellationToken
A cancellation token.
Returns
A task representing the asynchronous save operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
If SaveOptions.DisableFormatting is set, the output is not indented. If SaveOptions.OmitDuplicateNamespaces is set, duplicate namespace declarations will be removed.
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
SaveAsync(TextWriter, SaveOptions, CancellationToken)
- Source:
- XDocument.cs
- Source:
- XDocument.cs
- Source:
- XDocument.cs
Writes this XDocument 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 text writer to output the XML to.
- options
- SaveOptions
A set of load options.
- cancellationToken
- CancellationToken
A cancellation token.
Returns
A task representing the asynchronous save operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
If SaveOptions.DisableFormatting is set, the output is not indented. If SaveOptions.OmitDuplicateNamespaces is set, duplicate namespace declarations will be removed.
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).
