Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 4.91 KB

global-notification-status-enumeration.md

File metadata and controls

51 lines (38 loc) · 4.91 KB
title description ms.date ms.assetid
GLOBAL_NOTIFICATION_STATUS Enumeration
Describes the GLOBAL_NOTIFICATION_STATUS enumeration and details its syntax, members, remarks, code example, and requirements.
10/07/2016
8b0333b8-b0cd-4846-776d-29e52fbbb214

GLOBAL_NOTIFICATION_STATUS Enumeration

Defines the return values for global-level notifications.

Syntax

typedef enum GLOBAL_NOTIFICATION_STATUS{  
   GL_NOTIFICATION_CONTINUE,  
   GL_NOTIFICATION_HANDLED  
};

Members

Member name Description
GL_NOTIFICATION_CONTINUE Indicates that IIS should continue processing additional global-level notifications.
GL_NOTIFICATION_HANDLED Indicates that IIS has finished processing global-level notifications and should not process any additional global-level notifications.

Remarks

The members of the GLOBAL_NOTIFICATION_STATUS enumeration are used as return values from global-level notifications, and the members help to control process flow within the global-level notification processing pipeline. For example, returning GL_NOTIFICATION_CONTINUE from a global-level notification handler instructs IIS to continue processing additional global-level notifications, whereas returning GL_NOTIFICATION_HANDLED from a global-level notification handler informs IIS that global-level processing is complete and IIS should not process additional global-level notifications.

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 Enumerations
REQUEST_NOTIFICATION_STATUS Enumeration