Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

XmlWriter.WriteEntityRefAsync Method

.NET Framework 4.6 and 4.5

Asynchronously writes out an entity reference as &name;.

Namespace:  System.Xml
Assemblies:   System.Xml (in System.Xml.dll)
  System.Xml.ReaderWriter (in System.Xml.ReaderWriter.dll)

public virtual Task WriteEntityRefAsync(
	string name
)

Parameters

name
Type: System.String

The name of the entity reference.

Return Value

Type: System.Threading.Tasks.Task
The task that represents the asynchronous WriteEntityRef operation.

ExceptionCondition
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.”

InvalidOperationException

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.”

This is the asynchronous version of WriteEntityRef, with the same functionality. To use this method, you must set the Async flag to true.

.NET Framework

Supported in: 4.6, 4.5

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft