• Article

XmlResolver.GetEntity Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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)

Syntax

'Declaration
Public MustOverride Function GetEntity ( _
    absoluteUri As Uri, _
    role As String, _
    ofObjectToReturn As Type _
) As Object

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

Parameters

  • 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 or nulla null reference (Nothing in Visual Basic) if a type other than stream is specified.

Exceptions

Exception Condition
XmlException

ofObjectToReturn is not a Stream type.
ArgumentNullException

absoluteUri is nulla null reference (Nothing in Visual Basic).
Exception

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

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

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.