HttpApplication.GetVaryByCustomString Method (System.Web)

Switch View :
ScriptFree
.NET Framework Class Library
HttpApplication.GetVaryByCustomString Method

Provides an application-wide implementation of the VaryByCustom property.

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

Visual Basic
Public Overridable Function GetVaryByCustomString ( _
	context As HttpContext, _
	custom As String _
) As String
C#
public virtual string GetVaryByCustomString(
	HttpContext context,
	string custom
)
Visual C++
public:
virtual String^ GetVaryByCustomString(
	HttpContext^ context, 
	String^ custom
)
F#
abstract GetVaryByCustomString : 
        context:HttpContext * 
        custom:string -> string 
override GetVaryByCustomString : 
        context:HttpContext * 
        custom:string -> string 

Parameters

context
Type: System.Web.HttpContext
An HttpContext object that contains information about the current Web request.
custom
Type: System.String
The custom string that specifies which cached response is used to respond to the current request.

Return Value

Type: System.String
If the value of the custom parameter is "browser", the browser's Type; otherwise, null.
Remarks

You can override GetVaryByCustomString to add a new method for calculating custom vary-by values that are based on the current request. The implementation has to call the base class for custom values that it does not recognize. For more information, see How to: Cache Versions of a Page Using Custom Strings.

Version Information

.NET Framework

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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.
See Also

Reference

Other Resources