OutputCacheProfile.VaryByHeader Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the VaryByHeader property.

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

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

Property Value

Type: System.String

The VaryByHeader value.

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.

System_CAPS_noteNote

The VaryByHeader settings are the same ones used by the VaryByHeader attribute of the . 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.

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;

.NET Framework
Available since 2.0
Return to top
Show: