OutputCacheProfile.VaryByParam Property

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

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.

Gets or sets the VaryByParam property.

public:
 property System::String ^ VaryByParam { System::String ^ get(); void set(System::String ^ value); };

[System.Configuration.ConfigurationProperty("varyByParam")]
public string VaryByParam { get; set; }

[<System.Configuration.ConfigurationProperty("varyByParam")>]
member this.VaryByParam : string with get, set

Public Property VaryByParam As String

Property Value

String

The VaryByParam value.

Attributes: ConfigurationPropertyAttribute

Examples

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;

  ' Get the current VaryByParam property.
  Dim varyByParamValue As String = _
  outputCacheProfile.VaryByParam

  ' Set the VaryByParam property.
  outputCacheProfile.VaryByParam = _
  String.Empty

Remarks

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 @ OutputCache directive of the page using the profile.

Note

The OutputCacheProfile.VaryByParam settings are the same ones used by the VaryByParam attribute of the @ OutputCache. 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.

Applies to

Share via