HttpCacheVaryByHeaders.Item Property (String)

 
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 a custom header field that the ASP.NET output cache varies the cached responses by, and appends it to the out-going Vary HTTP header.

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

public bool this[
	string header
] { get; set; }

Parameters

header
Type: System.String

The name of the custom header.

Property Value

Type: System.Boolean

true when the ASP.NET output cache varies by the specified custom field; otherwise, false. The default value is false.

Exception Condition
ArgumentNullException

header is null.

The Vary header indicates the request-header fields that the server varies the response by.

For more information, see RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1, available on the World Wide Web Consortium (W3C) Web site. See section 14, "Header Field Definitions", for complete details.

The VaryByUnspecifiedParameters method is called internally if the specified header has the value * (an asterisk).

.NET Framework
Available since 1.1
Return to top
Show: