CHttpModule::CHttpModule-Methode 1.5

Artikel
04/12/2024

Initialisiert eine neue Instanz der CHttpModule-Klasse .

Syntax

CHttpModule (  
);

Parameter

Diese Methode nimmt zwei Parameter entgegen.

Hinweise

Der Konstruktor für die CHttpModule Klasse besteht protected darin, die direkte Erstellung einer CHttpModule Klasse zu verhindern. Sie müssen eine Klasse erstellen, von CHttpModuleder abgeleitet wird, da CHttpModule reine virtual Methoden definiert werden, die abgeleitete Klassen implementieren müssen.

Beispiel

Im folgenden Codebeispiel wird das Erstellen eines HTTP-Moduls auf Anforderungsebene veranschaulicht, das für die RQ_BEGIN_REQUEST-Ereignisbenachrichtigung registriert wird. Wenn eine Anforderung die integrierte Anforderungsverarbeitungspipeline eingibt, ruft IIS die OnBeginRequest-Methode des Beispielmoduls auf. Diese Methode schreibt einen Eintrag im Anwendungsprotokoll der Windows Ereignisanzeige, die "Hallo Welt!" in den Ereignisdaten enthält. Nach Abschluss der Verarbeitung wird das Modul beendet.

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:

    // Process an RQ_BEGIN_REQUEST event.
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog("Hello World!");
        return RQ_NOTIFICATION_CONTINUE;
    }

    // 
    MyHttpModule()
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
    }

    ~MyHttpModule()
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Close the handle to the Event Viewer.
            DeregisterEventSource( m_hEventLog );
            m_hEventLog = NULL;
        }
    }

private:

    // Create a handle for the event viewer.
    HANDLE m_hEventLog;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR szNotification)
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Write any strings to the Event Viewer and return.
            return ReportEvent(
                m_hEventLog,
                EVENTLOG_INFORMATION_TYPE,
                0, 0, NULL, 1, 0, &szNotification, NULL );
        }
        return FALSE;
    }
};

// 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(
        // Specify the class factory.
        new MyHttpModuleFactory,
        // Specify the event notifications.
        RQ_BEGIN_REQUEST,
        // Specify no post-event notifications.
        0
    );
}

Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen oder das Modul mithilfe der /EXPORT:RegisterModule Option kompilieren. Weitere Informationen finden Sie unter Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) Aufrufenkonvention verwenden, anstatt die aufrufende Konvention für jede Funktion explizit zu deklarieren.

Anforderungen

type	Beschreibung
Client	- IIS 7.0 unter Windows Vista IIS 7.5 unter Windows 7 IIS 8.0 unter Windows 8 IIS 10.0 unter Windows 10
Server	IIS 7.0 unter Windows Server 2008 - IIS 7.5 unter Windows Server 2008 R2 IIS 8.0 auf Windows Server 2012. - IIS 8.5 unter Windows Server 2012 R2 IIS 10.0 auf Windows Server 2016.
Produkt	- 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
Header	Httpserv.h

Weitere Informationen

CHttpModule-Klasse
REQUEST_NOTIFICATION_STATUS-Aufzählung

Freigeben über