HttpCacheVaryByHeaders.Item[String] Property

Reference

Definition

Namespace:: System.Web

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 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.

public:
 property bool default[System::String ^] { bool get(System::String ^ header); void set(System::String ^ header, bool value); };

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

member this.Item(string) : bool with get, set

Default Public Property Item(header As String) As Boolean

Parameters

header: String

The name of the custom header.

Property Value

Boolean

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

Exceptions

ArgumentNullException

header is null.

Remarks

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).

Applies to

Jaa