XmlWriter.WriteProcessingInstructionAsync(String, String) Method

Definition

Namespace:: System.Xml

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Asynchronously writes out a processing instruction with a space between the name and text as follows: <?name text?>.

public:
 virtual System::Threading::Tasks::Task ^ WriteProcessingInstructionAsync(System::String ^ name, System::String ^ text);

public virtual System.Threading.Tasks.Task WriteProcessingInstructionAsync (string name, string text);

public virtual System.Threading.Tasks.Task WriteProcessingInstructionAsync (string name, string? text);

abstract member WriteProcessingInstructionAsync : string * string -> System.Threading.Tasks.Task
override this.WriteProcessingInstructionAsync : string * string -> System.Threading.Tasks.Task

Public Overridable Function WriteProcessingInstructionAsync (name As String, text As String) As Task

Parameters

name: String

The name of the processing instruction.

text: String

The text to include in the processing instruction.

Returns

Task

The task that represents the asynchronous WriteProcessingInstruction operation.

Exceptions

InvalidOperationException

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

-or-

An XmlWriter asynchronous method was called without setting the Async flag to true. In this case, InvalidOperationException is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."

Remarks

This is the asynchronous version of WriteProcessingInstruction, with the same functionality. To use this method, you must set the Async flag to true.

Applies to