HttpCachePolicy.SetVaryByCustom Method (System.Web)

SetVaryByCustom 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

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 (Declaration)

Public Sub SetVaryByCustom ( _
    custom As String _
)

Visual Basic (Usage)

Dim instance As HttpCachePolicy
Dim custom As String

instance.SetVaryByCustom(custom)

public void SetVaryByCustom(
    string custom
)

Visual C++

public:
void SetVaryByCustom(
    String^ custom
)

JScript

public function SetVaryByCustom(
    custom : String
)

Parameters

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

Exceptions

Exception	Condition
ArgumentNullException	custom is nullNothingnullptra null reference (Nothing in Visual Basic).
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 3.5 Architecture.

Topic	Location
How to: Cache Versions of a Page Using Custom Strings	Building ASP .NET Web Applications
How to: Cache Versions of a Page Using Custom Strings	Building ASP .NET Web Applications
How to: Cache Versions of a Page Using Custom Strings	Building ASP .NET Web Applications in Visual Studio
How to: Cache Versions of a Page Using Custom Strings	Building ASP .NET Web Applications in Visual Studio

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");

JScript

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

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

Reference

HttpCachePolicy Class

HttpCachePolicy Members

System.Web Namespace