Export (0) Print
Expand All

HttpCachePolicy.SetCacheability Method (HttpCacheability, String)

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.

ExceptionCondition
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

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft