XmlWriter.WriteEntityRefAsync(String) Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Source:

XmlWriterAsync.cs

Asynchronously writes out an entity reference as &name;.

public:
 virtual System::Threading::Tasks::Task ^ WriteEntityRefAsync(System::String ^ name);

public virtual System.Threading.Tasks.Task WriteEntityRefAsync (string name);

abstract member WriteEntityRefAsync : string -> System.Threading.Tasks.Task
override this.WriteEntityRefAsync : string -> System.Threading.Tasks.Task

Public Overridable Function WriteEntityRefAsync (name As String) As Task

Parameters

name

String

The name of the entity reference.

Returns

Task

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

See also

• Asynchronous programming (C#)
• Asynchronous programming with Async and Await (Visual Basic)