This documentation is archived and is not being maintained.

HttpCacheVaryByHeaders.UserAgent Property

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.

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

public bool UserAgent { get; set; }

Property Value

Type: System.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.

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.

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


Response.Cache.VaryByHeaders.UserAgent = true;


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: