OutputCacheProfile.VaryByHeader Property

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the VaryByHeader property.

public:
 property System::String ^ VaryByHeader { System::String ^ get(); void set(System::String ^ value); };

[System.Configuration.ConfigurationProperty("varyByHeader")]
public string VaryByHeader { get; set; }

[<System.Configuration.ConfigurationProperty("varyByHeader")>]
member this.VaryByHeader : string with get, set

Public Property VaryByHeader As String

Property Value

String

The VaryByHeader value.

Attributes: ConfigurationPropertyAttribute

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;

  ' Get the current VaryByHeader.
  Dim varyByHeaderValue As String = _
  outputCacheProfile.VaryByHeader

  ' Set the VaryByHeader.
  outputCacheProfile.VaryByHeader = _
  String.Empty

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.

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via