XmlResolver.GetEntity Method

When overridden in a derived class, maps a URI to an object containing 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

The current version does not use this parameter when resolving URIs. This is provided for future extensibility purposes. For example, this can be mapped to the xlink:role and used as an implementation specific argument in other scenarios.

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 System.IO.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.

Security noteSecurity Note:

Your application can mitigate memory Denial of Service threats to the GetEntity method by implementing a wrapping implemented IStream that limits the number of bytes read. This helps to 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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft