Export (0) Print
Expand All

XmlResolver.GetEntity Method

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

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

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

Parameters

absoluteUri
Type: System.Uri

The URI returned from ResolveUri.

role
Type: System.String

Currently not used.

ofObjectToReturn
Type: System.Type

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

Return Value

Type: System.Object
A stream object or null if a type other than stream is specified.

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

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.

Security noteSecurity Note

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.

See XmlUrlResolver.GetEntity for an example using this method.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

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