This documentation is archived and is not being maintained.

RouteBase.GetVirtualPath Method

When overridden in a derived class, checks whether the route matches the specified values, and if so, generates a URL and retrieves information about the route.

Namespace:  System.Web.Routing
Assembly:  System.Web (in System.Web.dll)

'Declaration
Public MustOverride Function GetVirtualPath ( _
	requestContext As RequestContext, _
	values As RouteValueDictionary _
) As VirtualPathData

Parameters

requestContext
Type: System.Web.Routing.RequestContext
An object that encapsulates information about the requested route.
values
Type: System.Web.Routing.RouteValueDictionary
An object that contains the parameters for a route.

Return Value

Type: System.Web.Routing.VirtualPathData
An object that contains the generated URL and information about the route, or Nothing if the route does not match values.

To generate a URL, you use the GetVirtualPath method of the RouteCollection class. That method calls the GetVirtualPath method for each route in the collection to determine whether that route matches the values in values and can therefore generate the URL.

.NET Framework

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: