This documentation is archived and is not being maintained.

HttpCachePolicy.SetVaryByCustom Method

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

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

public void SetVaryByCustom(
	string custom
)

Parameters

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

ExceptionCondition
ArgumentNullException

custom is null.

InvalidOperationException

The SetVaryByCustom method has already been called.

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

TopicLocation
How to: Cache Versions of a Page Using Custom StringsBuilding ASP .NET Web Applications
How to: Cache Versions of a Page Using Custom StringsBuilding ASP .NET Web Applications

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.


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


.NET Framework

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

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.
Show: