OutputCacheProfile.VaryByParam Property

 

Gets or sets the VaryByParam property.

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

[ConfigurationPropertyAttribute("varyByParam")]
public string VaryByParam { get; set; }

Property Value

Type: System.String

The VaryByParam value.

The VaryByParam is a semicolon-delimited set of parameters used to vary the cached output. It allows varying the cached output by GET query string or form POST parameters. For instance, you can vary the user-control output to the cache by specifying the user-control name along with either a query string or a form POST parameter. For more information, see Caching Multiple Versions of User Control Output.

The VaryByParam setting must be defined in either the profile or the directive of the page using the profile.

System_CAPS_noteNote

The OutputCacheProfile.VaryByParam settings are the same ones used by the VaryByParam attribute of the . Varying by all parameters by setting the value of "*" is not recommended. It can result in cache overflow or a denial of service attack on the Web server.

The following code example shows how to use the VaryByParam property.


// Get the current VaryByParam.
String varyByParamValue = 
    outputCacheProfile.VaryByParam;

// Set the VaryByParam.
outputCacheProfile.VaryByParam = 
    string.Empty;

.NET Framework
Available since 2.0
Return to top
Show: