.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 (Declaration)
Public Overridable Function GetVaryByCustomString ( _
    context As HttpContext, _
    custom As String _
) As String
Visual Basic (Usage)
Dim instance As HttpApplication
Dim context As HttpContext
Dim custom As String
Dim returnValue As String

returnValue = instance.GetVaryByCustomString(context, _
    custom)
C#
public virtual string GetVaryByCustomString(
    HttpContext context,
    string custom
)
Visual C++
public:
virtual String^ GetVaryByCustomString(
    HttpContext^ context, 
    String^ custom
)
JScript
public function 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, nullNothingnullptra null reference (Nothing in Visual Basic).
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.

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, 1.1, 1.0
See Also

Reference

Other Resources

Tags :


Page view tracker