Skip to content

cglobalmodule-class.md

Latest commit

 

History

History
67 lines (53 loc) · 8.91 KB

cglobalmodule-class.md

File metadata and controls

67 lines (53 loc) · 8.91 KB
title CGlobalModule Class
description Describes the CGlobalModule class and provides the class' syntax, methods, remarks, an example, and requirements.
ms.date 10/07/2016
ms.assetid fbe43040-c8ab-f991-c09c-49362d321c67

CGlobalModule Class

Defines the base class for global-level HTTP modules.

Syntax

class CGlobalModule

Methods

The following table lists the methods exposed by the CGlobalModule class.

Name Description
OnGlobalApplicationPreload aaaabbbb-0000-cccc-1111-dddd2222eeee
OnGlobalApplicationResolveModules Represents the method that will handle a GlobalApplicationResolveModules event, which occurs when IIS resolves the registered modules.
OnGlobalApplicationStart Represents the method that will handle a GlobalApplicationStart event, which occurs when IIS starts an application.
OnGlobalApplicationStop Represents the method that will handle a GlobalApplicationStop event, which occurs when IIS shuts down an application.
OnGlobalCacheCleanup Represents the method that will handle a GlobalCacheCleanup event.
OnGlobalCacheOperation Represents the method that will handle a GlobalCacheOperation event, which occurs when IIS performs a cache-related operation.
OnGlobalConfigurationChange Represents the method that will handle a GlobalConfigurationChange event, which occurs when a change is made to a configuration file.
OnGlobalCustomNotification Represents the method that will handle a GlobalCustomNotification event, which occurs when a module raises a user-defined notification.
OnGlobalFileChange Represents the method that will handle a GlobalFileChange event, which occurs when a file within a Web site is changed.
OnGlobalHealthCheck Represents the method that will handle a GlobalHealthCheck event, which occurs when a health-related operation is executed.
OnGlobalPreBeginRequest Represents the method that will handle a GlobalPreBeginRequest event, which occurs before a request enters the pipeline.
OnGlobalRSCAQuery Represents the method that will handle a GlobalRSCAQuery event, which occurs when a Run-Time Status and Control query is executed.
OnGlobalStopListening Represents the method that will handle a GlobalStopListening event, which occurs when IIS stops accepting new requests.
OnGlobalThreadCleanup Represents the method that will handle a GlobalThreadCleanup event, which occurs when IIS returns a thread to the thread pool.
OnGlobalTraceEvent Represents the method that will handle a GlobalTraceEvent event, which occurs when a trace event is raised.
Terminate Represents the method that IIS calls when a global module has completed processing.

Derived Classes

This class contains no derived classes.

Remarks

The CGlobalModule class is the base class for global-level HTTP modules. Global-level HTTP modules must contain a class that inherits from CGlobalModule. CGlobalModule defines the methods that [!INCLUDEiisver] calls to handle global-level notifications when global-level events occur. An HTTP module can register for specific events by defining a list of notifications in a module's exported RegisterModule function. When a global-level module has finished processing, the module should use the CGlobalModule::Terminate method to remove CGlobalModule instances from memory.

Example

The following code example demonstrates how to create a simple "Hello World" global-level HTTP module. The module defines an exported RegisterModule function that creates an instance of a class that is derived from CGlobalModule. If the class cannot be created, the function exits with an error code; otherwise, the function calls the IHttpModuleRegistrationInfo::SetRequestNotifications method to register for the GL_PRE_BEGIN_REQUEST notification.

When a GL_PRE_BEGIN_REQUEST notification occurs, IIS calls the module's CGlobalModule::OnGlobalPreBeginRequest method to process the notification. The method calls a private method to write an event to the application log of the Event Viewer, and then it returns GL_NOTIFICATION_CONTINUE to notify IIS to continue processing other notifications. When processing is complete, IIS calls the module's CGlobalModule::Terminate method to remove the class from memory.

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

Web Server Core Classes
Creating Native-Code HTTP Modules
CHttpModule Class