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 */
public boolean get_UserAgent ()

/** @property */
public void set_UserAgent (boolean value)

public function get UserAgent () : boolean

public function set UserAgent (value : boolean)

Not applicable.

Property Value

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;

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: