Click to Rate and Give Feedback
TechNet
TechNet Library
Collapse All/Expand All Collapse All
This page is specific to
Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:
.NET Framework Class Library
WebRequest..::.CachePolicy Property

Gets or sets the cache policy for this request.

Namespace:  System.Net
Assembly:  System (in System.dll)
Visual Basic
Public Overridable Property CachePolicy As RequestCachePolicy
C#
public virtual RequestCachePolicy CachePolicy { get; set; }
Visual C++
public:
virtual property RequestCachePolicy^ CachePolicy {
    RequestCachePolicy^ get ();
    void set (RequestCachePolicy^ value);
}
F#
abstract CachePolicy : RequestCachePolicy with get, set
override CachePolicy : RequestCachePolicy with get, set

Property Value

Type: System.Net.Cache..::.RequestCachePolicy
A RequestCachePolicy object that defines a cache policy.

The current cache policy and the presence of the requested resource in the cache determine whether a response can be retrieved from the cache. Using cached responses usually improves application performance, but there is a risk that the response in the cache does not match the response on the server.

Default cache policy can be specified in the Machine.config configuration file or by setting the DefaultCachePolicy property for requests that use the Hypertext Transfer Protocol (HTTP) or Secure Hypertext Transfer Protocol (HTTPS) URI scheme.

A copy of a resource is only added to the cache if the response stream for the resource is retrieved and read to the end of the stream. So another request for the same resource could use a cached copy, depending on the cache policy level for this request.

The following code example demonstrates setting the cache policy for a Web request.

Visual Basic
' The following method demonstrates overriding the
' caching policy for a request.
Public Shared Function GetResponseNoCache(ByVal uri As Uri) As WebResponse
    ' Set a default policy level for the "http:" and "https" schemes.
    Dim policy As New HttpRequestCachePolicy(HttpRequestCacheLevel.Default)
    HttpWebRequest.DefaultCachePolicy = policy
    ' Create the request.
    Dim request As WebRequest = WebRequest.Create(uri)
    ' Define a cache policy for this request only. 
    Dim noCachePolicy As New HttpRequestCachePolicy(HttpRequestCacheLevel.NoCacheNoStore)
    request.CachePolicy = noCachePolicy
    Dim response As WebResponse = request.GetResponse()
    Console.WriteLine("IsFromCache? {0}", response.IsFromCache)
    Return response
End Function
C#
// The following method demonstrates overriding the
// caching policy for a request.
public static WebResponse GetResponseNoCache(Uri uri)
{
    // Set a default policy level for the "http:" and "https" schemes.
    HttpRequestCachePolicy policy = new HttpRequestCachePolicy(HttpRequestCacheLevel.Default);
    HttpWebRequest.DefaultCachePolicy = policy;
    // Create the request.
    WebRequest request = WebRequest.Create(uri);
    // Define a cache policy for this request only. 
    HttpRequestCachePolicy noCachePolicy = new HttpRequestCachePolicy(HttpRequestCacheLevel.NoCacheNoStore);
    request.CachePolicy = noCachePolicy;
    WebResponse response = request.GetResponse();
    Console.WriteLine("IsFromCache? {0}", response.IsFromCache);            
    return response;
}
Visual C++
// The following method demonstrates overriding the
// caching policy for a request.
static WebResponse^ GetResponseNoCache( Uri^ uri )
{
   // Set a default policy level for the "http:" and "https" schemes.
   HttpRequestCachePolicy^ policy = gcnew HttpRequestCachePolicy( HttpRequestCacheLevel::Default );
   HttpWebRequest::DefaultCachePolicy = policy;

   // Create the request.
   WebRequest^ request = WebRequest::Create( uri );

   // Define a cache policy for this request only. 
   HttpRequestCachePolicy^ noCachePolicy = gcnew HttpRequestCachePolicy( HttpRequestCacheLevel::NoCacheNoStore );
   request->CachePolicy = noCachePolicy;
   WebResponse^ response = request->GetResponse();
   Console::WriteLine( L"IsFromCache? {0}", response->IsFromCache );

   return response;
}

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2012 Microsoft. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker