XmlSecureResolver.GetEntityAsync(Uri, String, Type) Method

Reference

Definition

Namespace:: System.Xml

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Source:: XmlSecureResolver.cs

Source:: XmlSecureResolver.cs

Source:: XmlSecureResolver.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 maps a URI to an object that contains the actual resource.

public:
 override System::Threading::Tasks::Task<System::Object ^> ^ GetEntityAsync(Uri ^ absoluteUri, System::String ^ role, Type ^ ofObjectToReturn);

public override System.Threading.Tasks.Task<object> GetEntityAsync (Uri absoluteUri, string? role, Type? ofObjectToReturn);

public override System.Threading.Tasks.Task<object> GetEntityAsync (Uri absoluteUri, string role, Type ofObjectToReturn);

override this.GetEntityAsync : Uri * string * Type -> System.Threading.Tasks.Task<obj>

Public Overrides Function GetEntityAsync (absoluteUri As Uri, role As String, ofObjectToReturn As Type) As Task(Of Object)

Parameters

absoluteUri: Uri

The URI returned from ResolveUri(Uri, String).

role: String

Currently not used.

ofObjectToReturn: Type

The type of object to return. The current version only returns Stream objects.

Returns

Task<Object>

The stream returned by calling GetEntity on the underlying XmlResolver. If a type other than Stream is specified, the method returns null.

Remarks

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 GetEntity(Uri, String, Type).

Applies to