Edit

Share via

XmlWriter.WriteAttributeStringAsync(String, String, String, String) Method

  • Reference

Definition

Namespace:
System.Xml
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Source:
XmlWriterAsync.cs
Source:
XmlWriterAsync.cs
Source:
XmlWriterAsync.cs

Asynchronously writes out the attribute with the specified prefix, local name, namespace URI, and value.

public:
 System::Threading::Tasks::Task ^ WriteAttributeStringAsync(System::String ^ prefix, System::String ^ localName, System::String ^ ns, System::String ^ value);
public System.Threading.Tasks.Task WriteAttributeStringAsync (string prefix, string localName, string ns, string value);
public System.Threading.Tasks.Task WriteAttributeStringAsync (string? prefix, string localName, string? ns, string? value);
member this.WriteAttributeStringAsync : string * string * string * string -> System.Threading.Tasks.Task
Public Function WriteAttributeStringAsync (prefix As String, localName As String, ns As String, value 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 of the attribute.

value
String

The value of the attribute.

Returns

Task

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

Applies to

See also