Skip to content

cglobalmodule-onglobalfilechange-method.md

Latest commit

 

History

History
52 lines (38 loc) · 4.12 KB

cglobalmodule-onglobalfilechange-method.md

File metadata and controls

52 lines (38 loc) · 4.12 KB
title CGlobalModule::OnGlobalFileChange Method
description Learn how the OnGlobalFileChange method represents the method that will handle a GlobalFileChange event, which occurs when a file within a Web site is changed.
ms.date 10/07/2016
ms.assetid e7a07497-0000-13b4-34bd-82f9a3cbf266

CGlobalModule::OnGlobalFileChange Method

Represents the method that will handle a GlobalFileChange event, which occurs when a file within a Web site is changed.

Syntax

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalFileChange(  
   IN IGlobalFileChangeProvider* pProvider  
);

Parameters

pProvider
[IN] A pointer to an IGlobalFileChangeProvider interface.

Return Value

A GLOBAL_NOTIFICATION_STATUS value.

Remarks

When a global module has registered for the GL_FILE_CHANGE event notification, IIS will call the module's OnGlobalFileChange method when a file within the scope of a Web site is changed.

Note

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

IIS creates an IGlobalFileChangeProvider interface and passes the interface to a module's OnGlobalFileChange method. Developers can use this interface to retrieve information about the file that was changed.

Example

The following code example demonstrates how to create a global-level HTTP module that uses the IGlobalFileChangeProvider::GetFileName method to retrieve the path to a file that has been modified. The module then writes the path of the file to a log entry in the Event Viewer.

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