Skip to content

ihttpserver-recycleapplication-method.md

Latest commit

 

History

History
52 lines (39 loc) · 3.72 KB

ihttpserver-recycleapplication-method.md

File metadata and controls

52 lines (39 loc) · 3.72 KB
title IHttpServer::RecycleApplication Method
description Describes the IHttpServer::RecycleApplication method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid a80a7157-39a1-6c4e-ef4b-c03d6e913361

IHttpServer::RecycleApplication Method

Recycles an application.

Syntax

virtual VOID RecycleApplication(  
   PCWSTR pszAppConfigPath  
) = 0;

Parameters

pszAppConfigPath
A pointer to a string that contains the configuration path to recycle.

Return Value

VOID.

Remarks

The RecycleApplication method will request a recycle of the application that is specified by the configuration path in the pszAppConfigPath parameter. For example, the configuration path for the default Web site on a server running [!INCLUDEiisver] will usually resemble MACHINE/WEBROOT/APPHOST/Default Web Site.

Note

You can retrieve the configuration path by using the IHttpApplication::GetAppConfigPath method.

Example

The following code example demonstrates how to create an HTTP module that uses the IHttpApplication::GetAppConfigPath and RecycleApplication methods to retrieve and recycle the managed application that is processing the current request.

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

IHttpApplication::GetAppConfigPath Method
IHttpServer Interface
IHttpServer::RecycleProcess Method