XmlWriter.WriteSurrogateCharEntityAsync(Char, Char) Method

Definition

Namespace:

System.Xml

Assemblies:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlWriterAsync.cs

Asynchronously generates and writes the surrogate character entity for the surrogate character pair.

C#

public virtual System.Threading.Tasks.Task WriteSurrogateCharEntityAsync(char lowChar, char highChar);

Parameters

lowChar

Char

The low surrogate. This must be a value between 0xDC00 and 0xDFFF.

highChar

Char

The high surrogate. This must be a value between 0xD800 and 0xDBFF.

Returns

Task

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

Applies to

See also

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