HttpCacheVaryByParams Class
TOC
Collapse the table of content
Expand the table of content

HttpCacheVaryByParams Class

 

Provides a type-safe way to set the VaryByParams property.

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

System.Object
  System.Web.HttpCacheVaryByParams

public sealed class HttpCacheVaryByParams

NameDescription
System_CAPS_pubmethodHttpCacheVaryByParams()

Initializes a new instance of the HttpCacheVaryByParams class.

NameDescription
System_CAPS_pubpropertyIgnoreParams

Gets or sets a value indicating whether an HTTP response varies by Get or Post parameters.

System_CAPS_pubpropertyItem[String]

Gets or sets a value indicating whether the cache varies according to the specified HTTP request parameter.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The VaryByParams property identifies which HTTP Get or Post parameters ASP.NET uses to uniquely identify a variation of the response when there are multiple cached responses for a resource. This is useful when a response depends on a set of client inputs, such as headers or parameters.

The HttpCacheVaryByParams is not directly related to HTTP cache-control headers, but helps ensure that a client or proxy varies by the specified parameters. For more information about VaryByParams, 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 the HttpCacheVaryByParams object is accessed from the HttpCachePolicy object associated with an HttpResponse.

Response.Cache.SetExpires(DateTime.Now.AddSeconds(60));
Response.Cache.SetCacheability(HttpCacheability.Public);
Response.Cache.SetValidUntilExpires(false);
Response.Cache.VaryByParams["Category"] = true;

if (Response.Cache.VaryByParams["Category"])
{
   //...
}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft