IHttpContext::D isableNotifications, méthode

Article
07/19/2023

Désactive les notifications spécifiques qui sont en attente pour cette demande dans le module actuel.

Syntaxe

virtual VOID DisableNotifications(  
   IN DWORD dwNotifications,  
   IN DWORD dwPostNotifications  
) = 0;

Paramètres

dwNotifications
[IN] DWORD qui contient un masque de bits qui spécifie les notifications de demande à désactiver pour ce module.

dwPostNotifications
[IN] DWORD qui contient un masque de bits qui spécifie les notifications post-demande à désactiver pour ce module.

Valeur renvoyée

VOID.

Remarques

Vous pouvez utiliser la DisableNotifications méthode pour spécifier les notifications ou les notifications post-demande que vous souhaitez désactiver pour la requête actuelle. Par exemple, si un module que vous créez s’est inscrit pour les notifications RQ_AUTHENTICATE_REQUEST et RQ_AUTHORIZE_REQUEST , votre module peut être configuré pour ignorer la RQ_AUTHORIZE_REQUEST notification en fonction des conditions traitées dans la RQ_AUTHENTICATE_REQUEST notification.

Notes

Les notifications peuvent être désactivées uniquement pour la requête actuelle et dans le module actuel. La seule façon de désactiver les notifications implémentées dans d’autres modules consiste à retourner RQ_NOTIFICATION_FINISH_REQUEST à partir de votre module.

Notes

Les notifications peuvent être désactivées uniquement pour les événements déterministes ; ils ne peuvent pas être désactivés pour les événements non déterministes. Pour plus d’informations, consultez Comparaison des notifications Native-Code et Managed-Code.

Exemple

L’exemple suivant montre comment utiliser la DisableNotifications méthode pour créer un module HTTP qui désactive une notification CHttpModule::OnPostBeginRequest en attente sur la requête actuelle.

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Clear the existing response.
        pHttpContext->GetResponse()->Clear();
        // Set the MIME type to plain text.
        pHttpContext->GetResponse()->SetHeader(
            HttpHeaderContentType,"text/plain",
            (USHORT)strlen("text/plain"),TRUE);

        // Return a message to the client to indiciate the notification.
        WriteResponseMessage(pHttpContext,
            "\nNotification: ","OnBeginRequest");

        // Buffer to store the byte count.
        DWORD cbSent = 0;
        // Flush the response.
        pHttpContext->GetResponse()->Flush(false,true,&cbSent,NULL);

        // Specify which notifications to disable.
        // (Defined in the Httpserv.h file.)
        pHttpContext->DisableNotifications(RQ_BEGIN_REQUEST, 0);

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

    REQUEST_NOTIFICATION_STATUS
    OnPostBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Return a message to the client to indiciate the notification.
        WriteResponseMessage(pHttpContext,
            "\nNotification: ","OnPostBeginRequest");

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

    REQUEST_NOTIFICATION_STATUS
    OnAcquireRequestState(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Return a message to the client to indiciate the notification.
        WriteResponseMessage(pHttpContext,
            "\nNotification: ","OnAcquireRequestState");

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }

private:

    // Create a utility method that inserts a name/value pair into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszName,
        PCSTR pszValue
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create a data chunk.
        HTTP_DATA_CHUNK dataChunk;
        // Set the chunk to a chunk in memory.
        dataChunk.DataChunkType = HttpDataChunkFromMemory;
        // Buffer for bytes written of data chunk.
        DWORD cbSent;

        // Set the chunk to the first buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszName;
        // Set the chunk size to the first buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszName);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Set the chunk to the second buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszValue;
        // Set the chunk size to the second buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszValue);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

    void Terminate()
    {
        // Remove the class from memory.
        delete this;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST | RQ_ACQUIRE_REQUEST_STATE,
        RQ_BEGIN_REQUEST
    );
}

Votre module doit exporter la fonction RegisterModule . Vous pouvez exporter cette fonction en créant un fichier de définition de module (.def) pour votre projet, ou vous pouvez compiler le module à l’aide du /EXPORT:RegisterModule commutateur . Pour plus d’informations, consultez Procédure pas à pas : création d’un module HTTP Request-Level à l’aide de code natif.

Vous pouvez éventuellement compiler le code à l’aide de la __stdcall (/Gz) convention d’appel au lieu de déclarer explicitement la convention d’appel pour chaque fonction.

Spécifications

Type	Description
Client	- IIS 7.0 sur Windows Vista - IIS 7.5 sur Windows 7 - IIS 8.0 sur Windows 8 - IIS 10.0 sur Windows 10
Serveur	- IIS 7.0 sur Windows Server 2008 - IIS 7.5 sur Windows Server 2008 R2 - IIS 8.0 sur Windows Server 2012 - IIS 8.5 sur Windows Server 2012 R2 - IIS 10.0 sur Windows Server 2016
Produit	- IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - IIS Express 7.5, IIS Express 8.0, IIS Express 10.0
En-tête	Httpserv.h

Voir aussi

IHttpContext, interface
IHttpContext::GetIsLastNotification, méthode
IHttpContext::GetNextNotification, méthode
PFN_REGISTERMODULE, fonction

Partager via