ihttpserver-reportunhealthy-method.md

title	IHttpServer::ReportUnhealthy Method
description	Learn how the ReportUnhealthy method reports the worker process as unhealthy.
ms.date	10/07/2016
ms.assetid	08546d0e-7d6c-eb00-0cd8-2bcf460e7674

IHttpServer::ReportUnhealthy Method

Reports the worker process as unhealthy.

Syntax

virtual VOID ReportUnhealthy(  
   IN PCWSTR pszReasonString,  
   IN HRESULT hrReason  
) = 0;  

Parameters

pszReasonString
[IN] A pointer to a string that contains the cause of the unhealthy status.

hrReason
[IN] An HRESULT that contains the error condition for the unhealthy status.

Return Value

VOID.

Remarks

Developers can use the ReportUnhealthy method to notify IIS that a problem has occurred, and IIS will automatically call IWpfActions::FailWorkerProcess to shut down the worker process.

Example

The following code example demonstrates how to use the ReportUnhealthy method to create an HTTP module that reports an out-of-memory error and then exits.

[!code-cppIHttpServerReportUnhealthy#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 Request-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

IHttpServer Interface
IWpfActions::FailWorkerProcess Method