This topic has not yet been rated - Rate this topic

OutputCacheProfile.VaryByHeader Property

.NET Framework 3.5

Other Versions

Updated: April 2009

Gets or sets the VaryByHeader property.

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

Syntax

C++

JScript

[ConfigurationPropertyAttribute("varyByHeader")]
public string VaryByHeader { get; set; }

Property Value

Type: System.String
The VaryByHeader value.

Remarks

The VaryByHeader is a semicolon-delimited set of headers used to vary the cached output. These are HTTP headers associated with the request. For more information, see Caching Multiple Versions of a Page.

Note:
The VaryByHeader settings are the same ones used by the VaryByHeader attribute of the @ OutputCache. Varying by all headers by setting the value of "*" is not recommended. It can result in cache overflow or a denial of service attack on the Web server.

Examples

The following code example shows how to use the VaryByHeader property.

// Get the current VaryByHeader.
String varyByHeaderValue = 
    outputCacheProfile.VaryByHeader;

// Set the VaryByHeader.
outputCacheProfile.VaryByHeader = 
    string.Empty;

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