This documentation is archived and is not being maintained.

HttpCachePolicy.AddValidationCallback Method

Registers a validation callback for the current response.

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

public void AddValidationCallback (
	HttpCacheValidateHandler handler,
	Object data
)
public void AddValidationCallback (
	HttpCacheValidateHandler handler, 
	Object data
)
public function AddValidationCallback (
	handler : HttpCacheValidateHandler, 
	data : Object
)

Parameters

handler

The HttpCacheValidateHandler value.

data

The arbitrary user-supplied data that is passed back to the AddValidationCallback delegate.

Exception typeCondition

ArgumentNullException

The specified handler is a null reference (Nothing in Visual Basic).

TheAddValidationCallback method provides a mechanism to check the response programmatically in the cache before the response is returned to the client by the output cache.

Before the response is served from the Web server cache, all registered handlers are queried to ensure resource validity. If any handler sets a flag indicating that the cached response is not valid, the entry is marked as not valid and expelled from the cache. In this case, as well as when any handler indicates that the cached response should be ignored for this request, the request is then handled as if it were a cache miss.

The following code example demonstrates how to add a delegate to validate a request based on query string values.

<%@ OutputCache VaryByParam="none" Duration=600 %>
<Script Language="C#" runat="server">
   static string validationstate;
 
   public void Page_Load()
   {
      Response.Cache.AddValidationCallback(new HttpCacheValidateHandler(Validate), null);
      stamp.InnerHtml = DateTime.Now.ToString("r");
   }

   public static void Validate(HttpContext context, Object data, ref HttpValidationStatus status) 
   {
      if (context.Request.QueryString["Valid"] == "false") 
      {
         status = HttpValidationStatus.Invalid;
      } 
      else if (context.Request.QueryString["Valid"] == "ignore") 
      {
         status = HttpValidationStatus.IgnoreThisRequest;
      } 
      else 
      {
         status = HttpValidationStatus.Valid;
      }
   }

</Script>

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0
Show: