VirtualPathProvider.GetCacheKey Method (System.Web.Hosting)

GetCacheKey Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.Net Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

VirtualPathProvider..::.GetCacheKey Method

Returns a cache key to use for the specified virtual path.

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

Syntax

Visual Basic (Declaration)

Public Overridable Function GetCacheKey ( _
    virtualPath As String _
) As String

Visual Basic (Usage)

Dim instance As VirtualPathProvider
Dim virtualPath As String
Dim returnValue As String

returnValue = instance.GetCacheKey(virtualPath)

public virtual string GetCacheKey(
    string virtualPath
)

Visual C++

public:
virtual String^ GetCacheKey(
    String^ virtualPath
)

JScript

public function GetCacheKey(
    virtualPath : String
) : String

Parameters

virtualPath: Type: System..::.String
The path to the virtual resource.

Return Value

Type: System..::.String
A cache key for the specified virtual resource.

Remarks

Use the GetCacheKey method to provide a custom cache key for virtual resources. If you do not override the GetCacheKey method, the virtual path is used for the cache key.

Notes to Inheritors:

Only override the default GetCacheKey method if creating a cache key based on the virtual path will not work for your application.

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

VirtualPathProvider Class

VirtualPathProvider Members

System.Web.Hosting Namespace