Skip to content

icustomnotificationprovider-querynotificationtype-method.md

Latest commit

 

History

History
56 lines (39 loc) · 4.58 KB

icustomnotificationprovider-querynotificationtype-method.md

File metadata and controls

56 lines (39 loc) · 4.58 KB
title ICustomNotificationProvider::QueryNotificationType Method
ms.date 10/07/2016
description Create an iCustom Notification Provider interface with a Query Notification Type method that returns a pointer to a string unique for your notification type.
ms.assetid 3e9e0872-241b-ba12-14a5-80ab8de2a516

ICustomNotificationProvider::QueryNotificationType Method

Returns the unique identifier for a custom notification provider.

Syntax

virtual PCWSTR QueryNotificationType(  
   VOID  
) = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to a string that contains the custom notification type.

Remarks

When you are creating an ICustomNotificationProvider interface, your interface must provide a QueryNotificationType method that returns a pointer to a string that is unique for your notification. This allows modules that are listening for custom notifications to differentiate between the notifications that have been raised.

Example

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

  1. Registers for the RQ_BEGIN_REQUEST and RQ_CUSTOM_NOTIFICATION notifications.

  2. Creates a CHttpModule class that contains OnBeginRequest and OnCustomRequestNotification methods.

    • The OnBeginRequest 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 IHttpContext::NotifyCustomNotification method.

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

  3. Removes the CHttpModule class from memory and exits.

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