XmlWriter.WriteElementStringAsync(String, String, String, String) Method

Definition

Asynchronously writes an element with the specified prefix, local name, namespace URI, and value.

public:
 System::Threading::Tasks::Task ^ WriteElementStringAsync(System::String ^ prefix, System::String ^ localName, System::String ^ ns, System::String ^ value);
public System.Threading.Tasks.Task WriteElementStringAsync (string prefix, string localName, string ns, string value);
public System.Threading.Tasks.Task WriteElementStringAsync (string? prefix, string localName, string? ns, string value);
member this.WriteElementStringAsync : string * string * string * string -> System.Threading.Tasks.Task
Public Function WriteElementStringAsync (prefix As String, localName As String, ns As String, value As String) As Task

Parameters

prefix
String

The prefix of the element.

localName
String

The local name of the element.

ns
String

The namespace URI of the element.

value
String

The value of the element.

Returns

The task that represents the asynchronous WriteElementString operation.

Exceptions

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 WriteElementString, with the same functionality. To use this method, you must set the Async flag to true.

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 WriteElementString(String, String, String, String).

Applies to

See also