HttpCacheVaryByHeaders.UserAgent 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 value indicating whether the ASP.NET output cache varies the cached responses by the User-Agent header, and appends it to the out-going Vary HTTP header.

public:
 property bool UserAgent { bool get(); void set(bool value); };

public bool UserAgent { get; set; }

member this.UserAgent : bool with get, set

Public Property UserAgent As Boolean

Property Value

Boolean

true when the ASP.NET output cache varies by the User-Agent header, and adds it to the Vary HTTP header sent to the client; otherwise, false. The default value is false.

Examples

The following code example demonstrates how some action is performed only if the UserAgent property is true.

Response.Cache.VaryByHeaders.UserAgent = true;

Response.Cache.VaryByHeaders.UserAgent = True

Remarks

The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The User-Agent field specifies that the server selects the response based on the client's user-agent type.

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.

Applies to