Skip to content

ihttpserver-notifycustomnotification-method.md

Latest commit

 

History

History
61 lines (43 loc) · 5.39 KB

ihttpserver-notifycustomnotification-method.md

File metadata and controls

61 lines (43 loc) · 5.39 KB
title IHttpServer::NotifyCustomNotification Method
description Describes the IHttpServer::NotifyCustomNotification method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid fa61640c-8bb4-fb19-c69e-7219a3260fca

IHttpServer::NotifyCustomNotification Method

Raises a custom global-level notification.

Syntax

virtual GLOBAL_NOTIFICATION_STATUS NotifyCustomNotification(  
   ICustomNotificationProvider* pCustomOutput  
) = 0;

Parameters

pCustomOutput
A pointer to an ICustomNotificationProvider.

Return Value

A GLOBAL_NOTIFICATION_STATUS value.

Remarks

The NotifyCustomNotification method raises the custom notification that is specified by the ICustomNotificationProvider interface in the pCustomOutput parameter.

Your module must register for the GL_CUSTOM_NOTIFICATION notification, and your module must contain a CGlobalModule::OnGlobalCustomNotification method to process the custom notification. To raise the custom notification, your module must first create the instance of your custom ICustomNotificationProvider interface and pass that interface to the NotifyCustomNotification method for the current global context.

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.

    1. 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.

    2. 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 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 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

ICustomNotificationProvider Interface
IHttpServer Interface
IHttpContext::NotifyCustomNotification Method