This documentation is archived and is not being maintained.

HttpCacheVaryByHeaders.UserAgent Property

Gets or sets a value indicating whether the origin server adds the User-Agent header to the Vary HTTP header.

[Visual Basic]
Public Property UserAgent As Boolean
public bool UserAgent {get; set;}
public: __property bool get_UserAgent();
public: __property void set_UserAgent(bool);
public function get UserAgent() : Boolean;
public function set UserAgent(Boolean);

Property Value

The default value is false. When set to true, this property adds the User-Agent field to the Vary HTTP header sent to the client.


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 on HTTP cache control headers, see RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1, available on the World Wide Web Consortium's Web site at See section 14, "Header Field Definitions", for complete details.


This example performs some action only if the UserAgent property is True.

 [Visual Basic]
 'This example performs some action only if the UserAgent property
 'is True.
 If Response.Cache.VaryByHeaders.UserAgent = True Then
 End If


Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

HttpCacheVaryByHeaders Class | HttpCacheVaryByHeaders Members | System.Web Namespace