IHttpContext::SetRequestHandled, méthode

Indique que les gestionnaires de la requête actuelle sont terminés.

Syntaxe

virtual VOID SetRequestHandled(  
   VOID  
) = 0;  

Paramètres

Cette méthode ne prend aucun paramètre.

Valeur renvoyée

VOID.

Remarques

La SetRequestHandled méthode spécifie que le traitement des gestionnaires de la requête actuelle est terminé. Par exemple, si plusieurs gestionnaires de requêtes sont configurés pour un type de fichier spécifique, vous pouvez utiliser la méthode pour indiquer que le SetRequestHandled traitement est terminé pour la requête actuelle et que des gestionnaires supplémentaires ne doivent pas être exécutés.

Exemple

L’exemple de code suivant montre comment créer un module HTTP qui effectue les tâches suivantes :

1. Le module s’inscrit pour la notification RQ_PRE_EXECUTE_REQUEST_HANDLER .

2. Le module crée une classe CHttpModule qui contient une méthode OnPreExecuteRequestHandler .

3. Lorsqu’un client Web demande une URL, IIS appelle la méthode du OnPreExecuteRequestHandler module. Cette méthode effectue les tâches suivantes

   1. Récupère un pointeur vers une interface IScriptMapInfo .

   2. Récupère le gestionnaire de script pour la requête à l’aide de la méthode IScriptMapInfo::GetScriptProcessor .

   3. Si la demande concerne une page ASP, retourne un message au client Web indiquant que la demande a été gérée, puis appelle la SetRequestHandled méthode pour définir la requête comme gérée.

4. Le module supprime la classe de la CHttpModule mémoire, puis se ferme.

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

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

        // Retrieve an IScriptMapInfo interface.
        IScriptMapInfo * pScriptMapInfo = pHttpContext->GetScriptMap();

        // Test for an error.
        if (NULL != pScriptMapInfo)
        {
            // Create buffers to store the script processor path.
            PCWSTR pwszScriptProcessor;
            DWORD  cchScriptProcessor = 0;

            // Retrieve the script processor.
            pwszScriptProcessor =
                pScriptMapInfo->GetScriptProcessor(&cchScriptProcessor);

            // Test for an error.
            if ((pwszScriptProcessor != NULL) && (cchScriptProcessor > 0))
            {
                // Test for an ASP request.
                if (NULL != wcsstr(pwszScriptProcessor,L"\\asp.dll"))
                {
                    // 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 status message.
                    WriteResponseMessage(pHttpContext,
                        "ASP requests have been handled.");
                    // Indicate that handlers for this request have completed.
                    pHttpContext->SetRequestHandled();                    
                }
            }
        }         
        // Return processing to the pipeline.    
        return RQ_NOTIFICATION_CONTINUE;
    }

private:

    // Create a utility method that inserts a string value into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszBuffer
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create a data chunk. (Defined in the Http.h file.)
        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 buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszBuffer;
        // Set the chunk size to the buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszBuffer);
        // 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 we 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_PRE_EXECUTE_REQUEST_HANDLER,
        0
    );
}

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