Skip to content

cglobalmodule-onglobalcustomnotification-method.md

Latest commit

 

History

History
61 lines (43 loc) · 5.31 KB

cglobalmodule-onglobalcustomnotification-method.md

File metadata and controls

61 lines (43 loc) · 5.31 KB
title CGlobalModule::OnGlobalCustomNotification Method
description Describes the CGlobalModule::OnGlobalCustomNotification method and details its syntax, parameters, return value, remarks, and requirements.
ms.date 10/07/2016
ms.assetid f029ec16-7791-d9b4-042d-b18c2a4c36d7

CGlobalModule::OnGlobalCustomNotification Method

Represents the method that will handle a GlobalCustomNotification event, which occurs when a module raises a user-defined notification.

Syntax

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalCustomNotification(  
   IN ICustomNotificationProvider* pProvider  
);

Parameters

pProvider
[IN] A pointer to an ICustomNotificationProvider interface.

Return Value

A GLOBAL_NOTIFICATION_STATUS value.

Remarks

When a global module has registered for the GL_CUSTOM_NOTIFICATION event notification, IIS will call the module's OnGlobalCustomNotification method if a global custom notification is raised (for example, if a module calls IHttpServer::NotifyCustomNotification).

Note

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

Example

The following code example demonstrates how to create an HTTP module that performs the following tasks:

  1. Registers for the GL_PRE_BEGIN_REQUEST and GL_CUSTOM_NOTIFICATION notifications.

  2. Creates a CGlobalModule class that contains OnGlobalPreBeginRequest and OnGlobalCustomNotification methods.

    • The OnGlobalPreBeginRequest method writes an event to the Event Viewer that specifies the current notification. The method then creates an instance of an ICustomNotificationProvider interface and raises the custom notification by using the NotifyCustomNotification method.

    • The OnGlobalCustomNotification method uses the ICustomNotificationProvider::QueryNotificationType method to retrieve the unique identifier for the custom notification. If the unique identifier matches, the OnGlobalCustomNotification method writes an event to the Event Viewer that specifies that the custom notification was raised.

  3. Removes the CGlobalModule class from memory and then exits.

[!code-cppIHttpServerNotifyCustomNotification#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
IHttpServer::NotifyCustomNotification Method