This documentation is archived and is not being maintained.

XmlSecureResolver.GetEntity Method

Securely maps a URI to an object containing the actual resource. This method temporarily sets the System.Security.PermissionSet created in the constructor by calling PermissionSet.PermitOnly before calling GetEntity on the underlying XmlResolver to open the resource.

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

public override 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 Stream objects.

Return Value

Type: System.Object
A Stream object returned by calling GetEntity on the underlying XmlResolver. If a type other than stream is specified, null is returned.

ExceptionCondition
XmlException

ofObjectToReturn is neither null nor a Stream type.

UriFormatException

The specified URI is not an absolute URI.

NullReferenceException

absoluteUri is null.

Exception

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

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.

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

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
Show: