Skip to content

ihttpcontext-notifycustomnotification-method.md

Latest commit

 

History

History
70 lines (50 loc) · 5.65 KB

ihttpcontext-notifycustomnotification-method.md

File metadata and controls

70 lines (50 loc) · 5.65 KB
title IHttpContext::NotifyCustomNotification Method
description Describes the IHttpContext::NotifyCustomNotification method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid a7ed6a0f-5a56-2420-5c1d-16364a5bda73

IHttpContext::NotifyCustomNotification Method

Raises a custom request-level notification.

Syntax

virtual HRESULT NotifyCustomNotification(  
   ICustomNotificationProvider* pCustomOutput,  
   BOOL* pfCompletionExpected  
) = 0;

Parameters

pCustomOutput
A pointer to an ICustomNotificationProvider.

pfCompletionExpected
true if asynchronous completion is expected; otherwise, false.

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value Description
S_OK Indicates that the operation was successful.
ERROR_NOT_ENOUGH_MEMORY Indicates that there is insufficient memory to perform the operation.

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 RQ_CUSTOM_NOTIFICATION notification, and your module must contain a CHttpModule::OnCustomRequestNotification 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 request context.

Example

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

  1. Registers for the RQ_BEGIN_REQUEST and RQ_CUSTOM_NOTIFICATION notifications.

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

    1. The OnBeginRequest method writes to the Event Viewer an event 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 OnCustomRequestNotification method uses the ICustomNotificationProvider::QueryNotificationType method to retrieve the unique identifier for the custom notification. If the unique identifier matches, the OnCustomRequestNotification method writes to the Event Viewer an event that specifies that the custom notification was raised.

  3. Removes the CHttpModule class from memory and then 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
IHttpContext Interface
IHttpServer::NotifyCustomNotification Method