XmlWriter.WriteStartAttributeAsync(String, String, String) Method

Definition

Asynchronously writes the start of an attribute with the specified prefix, local name, and namespace URI.

protected public:
 virtual System::Threading::Tasks::Task ^ WriteStartAttributeAsync(System::String ^ prefix, System::String ^ localName, System::String ^ ns);
protected internal virtual System.Threading.Tasks.Task WriteStartAttributeAsync (string prefix, string localName, string ns);
protected internal virtual System.Threading.Tasks.Task WriteStartAttributeAsync (string? prefix, string localName, string? ns);
abstract member WriteStartAttributeAsync : string * string * string -> System.Threading.Tasks.Task
override this.WriteStartAttributeAsync : string * string * string -> System.Threading.Tasks.Task
Protected Friend Overridable Function WriteStartAttributeAsync (prefix As String, localName As String, ns As String) As Task

Parameters

prefix
String

The namespace prefix of the attribute.

localName
String

The local name of the attribute.

ns
String

The namespace URI for the attribute.

Returns

The task that represents the asynchronous WriteStartAttribute 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 WriteStartAttribute, 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 WriteStartAttribute(String, String, String).

Applies to

See also