HttpCacheVaryByParams.Item Property (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public bool this[
	string header
] { get; set; }

Parameters

header
Type: System.String

The name of the custom parameter.

Property Value

Type: System.Boolean

true if the cache should vary by the specified parameter value.

Exception Condition
ArgumentNullException

header is null.

When used as an accessor (getter), the Item indexer returns true if a value for the specified parameter is found in the current parameters collection, or if the collection is set to vary by * (an asterisk), which indicates all parameters.

When used as a mutator (setter), the Item indexer sets the value for the parameter in the parameters collection that corresponds to the specified header to true. The value * can be specified, which indicates all parameters.

The following code example demonstrates how the Item indexer 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
Return to top
Show: