XmlWriter.WriteAttributesAsync(XmlReader, Boolean) Method

Definition

Asynchronously writes out all the attributes found at the current position in the XmlReader.

public:
 virtual System::Threading::Tasks::Task ^ WriteAttributesAsync(System::Xml::XmlReader ^ reader, bool defattr);
public virtual System.Threading.Tasks.Task WriteAttributesAsync (System.Xml.XmlReader reader, bool defattr);
abstract member WriteAttributesAsync : System.Xml.XmlReader * bool -> System.Threading.Tasks.Task
override this.WriteAttributesAsync : System.Xml.XmlReader * bool -> System.Threading.Tasks.Task
Public Overridable Function WriteAttributesAsync (reader As XmlReader, defattr As Boolean) As Task

Parameters

reader
XmlReader

The XmlReader from which to copy the attributes.

defattr
Boolean

true to copy the default attributes from the XmlReader; otherwise, false.

Returns

The task that represents the asynchronous WriteAttributes 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 WriteAttributes, 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 WriteAttributes(XmlReader, Boolean).

Applies to

See also