XDocument.SaveAsync メソッド

定義

名前空間:

System.Xml.Linq

アセンブリ:

System.Xml.XDocument.dll

オーバーロード

SaveAsync(XmlWriter, CancellationToken)	この XDocument を XmlWriter に書き込みます。
SaveAsync(Stream, SaveOptions, CancellationToken)	この XDocument を Stream に出力します。
SaveAsync(TextWriter, SaveOptions, CancellationToken)	この XDocument を TextWriter に書き込みます。

SaveAsync(XmlWriter, CancellationToken)

ソース:

XDocument.cs

この XDocument を 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

パラメーター

writer

XmlWriter

XML の出力先のライター。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task

非同期保存操作を表すタスク。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Save(XmlWriter)スローされる例外に関するページを参照してください。

SaveAsync(Stream, SaveOptions, CancellationToken)

ソース:

XDocument.cs

この XDocument を 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

パラメーター

stream

Stream

XML が書き込まれるストリーム。

options

SaveOptions

読み込みオプションのセット。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task

非同期保存操作を表すタスク。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

が設定されている場合 SaveOptions.DisableFormatting 、出力はインデントされません。 が設定されている場合 SaveOptions.OmitDuplicateNamespaces 、重複する名前空間宣言は削除されます。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Save(Stream, SaveOptions)スローされる例外に関するページを参照してください。

SaveAsync(TextWriter, SaveOptions, CancellationToken)

ソース:

XDocument.cs

この XDocument を 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

パラメーター

textWriter

TextWriter

XML を出力するテキスト ライター。

options

SaveOptions

読み込みオプションのセット。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task

非同期保存操作を表すタスク。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

が設定されている場合 SaveOptions.DisableFormatting 、出力はインデントされません。 が設定されている場合 SaveOptions.OmitDuplicateNamespaces 、重複する名前空間宣言は削除されます。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Save(TextWriter, SaveOptions)スローされる例外に関するページを参照してください。