Skip to content

cglobalmodule-onglobalcachecleanup-method.md

Latest commit

 

History

History
50 lines (37 loc) · 3.63 KB

cglobalmodule-onglobalcachecleanup-method.md

File metadata and controls

50 lines (37 loc) · 3.63 KB
title CGlobalModule::OnGlobalCacheCleanup Method
ms.date 10/07/2016
description Learn how to create a global-level HTTP module that registers for the GL_CACHE_CLEANUP notification.
ms.assetid 18e85b91-c3e0-c4b3-7a69-90494e21a358

CGlobalModule::OnGlobalCacheCleanup Method

Represents the method that will handle a GlobalCacheCleanup event.

Syntax

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalCacheCleanup(  
   VOID  
);

Parameters

This method takes no parameters.

Return Value

A GLOBAL_NOTIFICATION_STATUS value.

Remarks

When a global module has registered for the GL_CACHE_CLEANUP event notification, IIS will call the module's OnGlobalCacheCleanup method when the cache is purged before termination.

Note

Global modules can register for the GlobalCacheCleanup event notification by registering for GL_CACHE_CLEANUP in the module's RegisterModule function.

Example

The following code example demonstrates how to create a global-level HTTP module that registers for the GL_CACHE_CLEANUP notification. When a cache cleanup operation occurs, IIS will call the example module's OnGlobalCacheCleanup method. This method will write an entry in the application log of the Windows Event Viewer and then exit.

[!code-cppCGlobalModuleGlobalCacheCleanup#1]

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Global-Level HTTP Module By Using Native Code.

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Httpserv.h

See Also

CGlobalModule Class
CGlobalModule::OnGlobalCacheOperation Method