XmlWriter.WriteDocTypeAsync(String, String, String, String) Method

Reference

Definition

Namespace:: System.Xml

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Source:: XmlWriterAsync.cs

Source:: XmlWriterAsync.cs

Source:: XmlWriterAsync.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Asynchronously writes the DOCTYPE declaration with the specified name and optional attributes.

public:
 virtual System::Threading::Tasks::Task ^ WriteDocTypeAsync(System::String ^ name, System::String ^ pubid, System::String ^ sysid, System::String ^ subset);

public virtual System.Threading.Tasks.Task WriteDocTypeAsync (string name, string pubid, string sysid, string subset);

public virtual System.Threading.Tasks.Task WriteDocTypeAsync (string name, string? pubid, string? sysid, string? subset);

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

Public Overridable Function WriteDocTypeAsync (name As String, pubid As String, sysid As String, subset As String) As Task

Parameters

name: String

The name of the DOCTYPE. This must be non-empty.

pubid: String

If non-null it also writes PUBLIC "pubid" "sysid" where pubid and sysid are replaced with the value of the given arguments.

sysid: String

If pubid is null and sysid is non-null it writes SYSTEM "sysid" where sysid is replaced with the value of this argument.

subset: String

If non-null it writes [subset] where subset is replaced with the value of this argument.

Returns

Task

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

Applies to