Microsoft Internet Security and Acceleration Server 2004 SDK

SetUserCachingKey

The SetUserCachingKey callback function is used by Web filters to set the user caching key. The user caching key is the key that the request will be cached with. This key is used to check if the given request is in the cache, so there is no need to pass the request to the server. The key is also used to cache the server response after it arrives. The URL of the request is used as the default cache key.

The SetUserCachingKey callback function is declared as:

BOOL WINAPI * SetUserCachingKey(
  struct _HTTP_FILTER_CONTEXT* pfc,
  LPSTR lpszCacheKey 
);

Parameters

pfc
Pointer to the HTTP_FILTER_CONTEXT data structure that is associated with the current, active HTTP session. Pass the filter context in this parameter.
lpszCacheKey
Pointer to a null-terminated string containing the new caching key.

Return Values

Returns TRUE if the function succeeded, or FALSE if the function failed.

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Wpxhttpfilt.h.

See Also

Callback Functions