| title | CGlobalModule::OnGlobalHealthCheck Method |
|---|---|
| description | CGlobalModule::OnGlobalHealthCheck Method represents the method that will handle a GlobalHealthCheck event, which occurs when a health-related operation is executed. |
| ms.date | 10/07/2016 |
| ms.assetid | fb5cd1b1-c034-55a5-bcc4-b1f66ba03498 |
Represents the method that will handle a GlobalHealthCheck event, which occurs when a health-related operation is executed.
virtual GLOBAL_NOTIFICATION_STATUS OnGlobalHealthCheck(
VOID
); This method takes no parameters.
A GLOBAL_NOTIFICATION_STATUS value.
When a global module has registered for the GL_HEALTH_CHECK event notification, IIS will call the module's OnGlobalHealthCheck method when a health-related operation occurs. For example, if another module calls the IHttpServer::ReportUnhealthy method, IIS will call OnGlobalHealthCheck for any modules that have registered for the GL_HEALTH_CHECK notification.
Note
Global modules can register for the GlobalHealthCheck event notification by registering for GL_HEALTH_CHECK in the module's RegisterModule function.
The following code example demonstrates how to create a global-level HTTP module that registers for the GL_HEALTH_CHECK event notification. If a health-related operation occurs, IIS will call the example module's OnGlobalHealthCheck method. This method will write an entry in the application log of the Windows Event Viewer and then exit.
[!code-cppCGlobalModuleGlobalHealthCheck#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.
| 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 |