HttpCachePolicy.SetCacheability Method (HttpCacheability, 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.

Sets the Cache-Control header to one of the values of HttpCacheability and appends an extension to the directive.

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

public void SetCacheability(
	HttpCacheability cacheability,
	string field
)

Parameters

cacheability
Type: System.Web.HttpCacheability

The HttpCacheability enumeration value to set the header to.

field
Type: System.String

The cache control extension to add to the header.

Exception Condition
ArgumentNullException

field is null.

ArgumentException

cacheability is not Private or NoCache.

The field name extension is valid only when used with the private or no-cache directives. For more information, see RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1, available on the World Wide Web Consortium (W3C) Web site.

This method will throw an invalid argument exception if incompatible directives and extensions are combined.

SetCacheability is introduced in the .NET Framework version 3.5. For more information, see .NET Framework Versions and Dependencies.

The following code example demonstrates how the Cache-Control header is set to the enumeration value private and adds a cache-control extension. The modified directive means that in addition to any non-shared cache, any cache shared only by members of the community named "DEV" may cache the response.

Response.Cache.SetCacheability(HttpCacheability.Private, "Community=DEV");

.NET Framework
Available since 1.1
Return to top
Show: