XmlWriter.WriteCommentAsync(String) XmlWriter.WriteCommentAsync(String) XmlWriter.WriteCommentAsync(String) XmlWriter.WriteCommentAsync(String) Method

定義

指定したテキストを含むコメント <!--...--> を非同期に書き込みます。Asynchronously writes out a comment <!--...--> containing the specified text.

public:
 virtual System::Threading::Tasks::Task ^ WriteCommentAsync(System::String ^ text);
public virtual System.Threading.Tasks.Task WriteCommentAsync (string text);
abstract member WriteCommentAsync : string -> System.Threading.Tasks.Task
override this.WriteCommentAsync : string -> System.Threading.Tasks.Task
Public Overridable Function WriteCommentAsync (text As String) As Task

パラメーター

text
String String String String

コメント内に配置するテキスト。Text to place inside the comment.

戻り値

非同期の WriteComment 操作を表すタスク。The task that represents the asynchronous WriteComment operation.

例外

先行の非同期操作が完了する前に、XmlWriter メソッドが呼び出されました。An XmlWriter method was called before a previous asynchronous operation finished. この場合、「非同期操作が既に実行されています」というメッセージと共に InvalidOperationException がスローされます。In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

- または --or-

Async フラグを true に設定せずに、XmlWriter 非同期メソッドが呼び出されました。An XmlWriter asynchronous method was called without setting the Async flag to true. この場合、非同期メソッドを使用するには XmlWriterSettings.Async を true に設定する必要があることを示すメッセージと共に InvalidOperationException がスローされます。In this case, InvalidOperationException is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."

注釈

これはのWriteComment非同期バージョンであり、同じ機能を備えています。This is the asynchronous version of WriteComment, with the same functionality. このメソッドを使用するには、 Asyncフラグをにtrue設定する必要があります。To use this method, you must set the Async flag to true.

適用対象

こちらもご覧ください