HttpCacheVaryByParams Class
Definition
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.
Provides a type-safe way to set the VaryByParams property.
public ref class HttpCacheVaryByParams sealed
public sealed class HttpCacheVaryByParams
type HttpCacheVaryByParams = class
Public NotInheritable Class HttpCacheVaryByParams
- Inheritance
-
HttpCacheVaryByParams
Examples
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"])
{
//...
}
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") Then
'...
End If
Remarks
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.
Constructors
HttpCacheVaryByParams() |
Initializes a new instance of the HttpCacheVaryByParams class. |
Properties
IgnoreParams |
Gets or sets a value indicating whether an HTTP response varies by |
Item[String] |
Gets or sets a value indicating whether the cache varies according to the specified HTTP request parameter. |
Methods
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetParams() |
Gets an array of values which specify the HTTP |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
SetParams(String[]) |
Sets an array of values which specify the HTTP |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |