XmlResolver.GetEntity(Uri, String, Type) Method

Reference

Definition

Namespace:: System.Xml

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Source:: XmlResolver.cs

Source:: XmlResolver.cs

Source:: XmlResolver.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.

When overridden in a derived class, maps a URI to an object that contains the actual resource.

public:
 abstract System::Object ^ GetEntity(Uri ^ absoluteUri, System::String ^ role, Type ^ ofObjectToReturn);

public abstract object? GetEntity (Uri absoluteUri, string? role, Type? ofObjectToReturn);

public abstract object GetEntity (Uri absoluteUri, string role, Type ofObjectToReturn);

abstract member GetEntity : Uri * string * Type -> obj

Public MustOverride Function GetEntity (absoluteUri As Uri, role As String, ofObjectToReturn As Type) As 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 System.IO.Stream objects.

Returns

Object

A stream object or null if a type other than stream is specified.

Exceptions

XmlException

ofObjectToReturn is not a Stream type.

UriFormatException

The specified URI is not an absolute URI.

ArgumentNullException

absoluteUri is null.

Exception

There is a runtime error (for example, an interrupted server connection).

Examples

See XmlUrlResolver.GetEntity for an example using this method.

Remarks

This method is used when the caller wants to map a given URI into the object containing the actual resource that the URI represents. The type of object returned is negotiable; however, the implementation must always support System.IO.Stream.

For the asynchronous version of this method, see GetEntityAsync.

Important

Your application can mitigate memory denial of service threats to the GetEntity method by implementing an IStream that limits the number of bytes read. This helps guard against situations where malicious code attempts to pass an infinite stream of bytes to the GetEntity method.

Applies to