PFN_REGISTERMODULE, fonction

Article
07/19/2023

Définit le prototype de RegisterModule fonction pour les modules HTTP en code natif.

Syntaxe

typedef HRESULT(WINAPI* PFN_REGISTERMODULE)(  
   DWORD dwServerVersion,  
   IHttpModuleRegistrationInfo* pModuleInfo,  
   IHttpServer* pGlobalInfo  
);

Paramètres

dwServerVersion
DWORD qui contient le numéro de version principale IIS.

pModuleInfo
Pointeur vers une interface IHttpModuleRegistrationInfo .

pGlobalInfo
Pointeur vers une interface IHttpServer .

Valeur renvoyée

Élément HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Valeur	Description
S_OK	Indique que l’opération a réussi.

Notes

Votre module peut retourner n’importe quelle valeur valide HRESULT , mais il doit retourner au moins S_OK pour indiquer que votre RegisterModule fonction a réussi.

Remarques

PFN_REGISTERMODULE est un prototype de fonction pour la RegisterModule fonction que tous les modules HTTP doivent implémenter pour leur point d’entrée DLL.

Lorsque vous créez un module HTTP, votre module doit ajouter la méthode suivante RegisterModule :

HRESULT RegisterModule(  
   DWORD dwServerVersion,  
   IHttpModuleRegistrationInfo* pModuleInfo,  
   IHttpServer* pGlobalInfo  
)

Tous les modules HTTP doivent exporter leur RegisterModule fonction pour qu’IIS charge le module. Vous pouvez exporter la RegisterModule fonction en créant un fichier de définition de module (.def) pour votre projet DLL ou en compilant le module à l’aide du /EXPORT:RegisterModule commutateur .

Votre RegisterModule fonction doit utiliser l’interface IHttpModuleRegistrationInfo pour s’inscrire aux notifications à l’aide des méthodes SetRequestNotifications et SetGlobalNotifications . RegisterModule devront également utiliser IHttpModuleRegistrationInfo pour inscrire des priorités de module à l’aide des méthodes SetPriorityForRequestNotification et SetPriorityForGlobalNotification .

Le dwServerVersion paramètre contient le numéro de version principale de la version d’IIS qui charge le module. Par exemple, pour IIS 7.0, le dwServerVersion paramètre contient un 7.

Quand IIS appelle votre RegisterModule fonction, elle fournit une IHttpServer interface, que votre module peut utiliser pour récupérer des informations au niveau du serveur.

Notes

Les événements de trace ne doivent pas être déclenchés (par le biais de la méthode IHttpTraceContext::QuickTrace ou de tout autre moyen par le biais de la méthode IHttpServer::GetTraceContext) à l’intérieur de l’implémentation de la RegisterModule fonction. Le déclenchement d’événements de trace à l’intérieur de RegisterModule peut entraîner une violation d’accès, car il est trop tôt dans le pipeline de requête.

Exemple

L’exemple de code suivant montre comment créer un module HTTP simple « Hello World ». Le module définit une fonction exportée RegisterModule qui transmet une instance d’une interface IHttpModuleFactory à la méthode IHttpModuleRegistrationInfo::SetRequestNotifications et s’inscrit pour la notification RQ_BEGIN_REQUEST. IIS utilise la méthode IHttpModuleFactory::GetHttpModule pour créer un instance d’une classe CHttpModule et retourne une status réussie. IIS utilise également la méthode IHttpModuleFactory::Terminate pour supprimer la fabrique de la mémoire.

Lorsqu’une RQ_BEGIN_REQUEST notification se produit, IIS appelle la méthode CHttpModule::OnBeginRequest du module pour traiter la requête actuelle. OnBeginRequest efface la mémoire tampon de réponse et modifie le type MIME de la réponse. La méthode crée ensuite un bloc de données qui contient une chaîne « Hello World » et retourne la chaîne à un client Web. Enfin, le module retourne un indicateur de status qui avertit IIS que toutes les notifications sont terminées, puis se ferme.

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

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

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Clear the existing response.
            pHttpResponse->Clear();
            // Set the MIME type to plain text.
            pHttpResponse->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);

            // Create a string with the response.
            PCSTR pszBuffer = "Hello World!";
            // 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 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 = pHttpResponse->WriteEntityChunks(
                &dataChunk,1,FALSE,TRUE,&cbSent);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the HTTP status.
                pHttpResponse->SetStatus(500,"Server Error",0,hr);
            }

            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

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

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

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

        // 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 CHelloWorldFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

Votre module doit exporter la RegisterModule fonction. 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

IHttpModuleRegistrationInfo, interface
IHttpModuleRegistrationInfo::SetGlobalNotifications, méthode
IHttpModuleRegistrationInfo::SetPriorityForGlobalNotification, méthode
IHttpModuleRegistrationInfo::SetPriorityForRequestNotification, méthode
IHttpModuleRegistrationInfo::SetRequestNotifications, méthode
IHttpServer, interface