HttpCachePolicy.SetVaryByCustom Method (System.Web)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

HttpCachePolicy.SetVaryByCustom Method

Specifies a custom text string to vary cached output responses by.

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

Syntax

Visual Basic

Public Sub SetVaryByCustom ( _
	custom As String _
)

public void SetVaryByCustom(
	string custom
)

Visual C++

public:
void SetVaryByCustom(
	String^ custom
)

member SetVaryByCustom : 
        custom:string -> unit

Parameters

custom: Type: System.String
The text string to vary cached output by.

Exceptions

Exception	Condition
ArgumentNullException	custom is null.
InvalidOperationException	The SetVaryByCustom method has already been called.

Remarks

SetVaryByCustom is introduced in the .NET Framework version 3.5. For more information, see .NET Framework Versions and Dependencies.

Examples

The following code example demonstrates how to set the custom vary string to "Accept-Charset", which causes the origin-server's cache to choose one of several cached responses depending on the browser's Accept-Charset header.

Visual Basic


Response.Cache.SetVaryByCustom("Accept-Charset")


Response.Cache.SetVaryByCustom("Accept-Charset");

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.

Reference

HttpCachePolicy Class

System.Web Namespace

Community Content

Tom Lianza

Example is incorrect

The example on this page shows an HTTP header's value as the cache key, but that's not what SetVaryByCustom does, per the other documentation: http://msdn.microsoft.com/en-us/library/5ecf4420(v=VS.85).aspx $0$0 $0 $0It looks like you're describing the VaryByHeader usage instead.$0 $0http://msdn.microsoft.com/en-us/library/system.web.ui.outputcacheparameters.varybyheader(v=VS.85).aspx$0