Edit

Share via


XmlDictionaryWriter.WriteValueAsync(IStreamProvider) Method

Definition

Asynchronously writes a value from an IStreamProvider.

public:
 virtual System::Threading::Tasks::Task ^ WriteValueAsync(System::Xml::IStreamProvider ^ value);
public virtual System.Threading.Tasks.Task WriteValueAsync (System.Xml.IStreamProvider value);
abstract member WriteValueAsync : System.Xml.IStreamProvider -> System.Threading.Tasks.Task
override this.WriteValueAsync : System.Xml.IStreamProvider -> System.Threading.Tasks.Task
Public Overridable Function WriteValueAsync (value As IStreamProvider) As Task

Parameters

value
IStreamProvider

The IStreamProvider value to write.

Returns

The task that represents the asynchronous WriteValue operation.

Exceptions

An XmlDictionaryWriter 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 XmlDictionaryWriter 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 WriteValue, 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 WriteValue(IStreamProvider).

Applies to

See also