IGlobalTraceEventProvider::GetCurrentHttpRequestContext-Methode

Artikel
07/19/2023

Ruft den HTTP-Kontext für Ablaufverfolgungsereignisse ab, die anforderungsspezifisch sind.

Syntax

virtual HRESULT GetCurrentHttpRequestContext(  
   IHttpContext** ppHttpContext  
) = 0;

Parameter

ppHttpContext
Ein Zeiger auf die Adresse einer IHttpContext Schnittstelle, andernfalls NULL.

Rückgabewert

HRESULT. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle.

Wert	Definition
S_OK	Gibt an, dass der Vorgang erfolgreich war.
ERROR_NOT_SUPPORTED	Gibt an, dass die -Methode nicht unterstützt wird.

Bemerkungen

Von CGlobalModule abgeleitete Klassen, die sich für GL_TRACE_EVENT Ereignistypen registrieren, erhalten einen IGlobalTraceEventProvider-Zeiger als Parameter für die reine virtualCGlobalModule::OnGlobalTraceEvent-Methode. Sie können dann einen IHttpContext-Zeiger abrufen, indem Sie die GetCurrentHttpRequestContext -Methode für diesen IGlobalTraceEventProvider Zeiger aufrufen.

Eine mögliche Verwendung für GetCurrentHttpRequestContext besteht darin, eine benutzerdefinierte Pufferung von Ereignissen bereitzustellen.

GetCurrentHttpRequestContext Das Verhalten hängt von der Implementierung ab. Sie sollten die folgenden Informationen als Richtlinie verwenden, aber sie sind möglicherweise nicht in allen Szenarien korrekt:

Klassen, die HTTP-Ablaufverfolgungsereignisse bereitstellen, deklarieren eine private``IHttpContext Zeigermembervariable. Diese Variable wird während der Erstellung zu einem gültigen IHttpContext Zeiger initialisiert. Wenn Sie aufrufen GetCurrentHttpRequestContext, wird der dereferenzierte ppHttpContext Parameter auf diese Variable festgelegt, und S_OK wird zurückgegeben.
Klassen, die globale Ablaufverfolgungsereignisse bereitstellen, ändern den ppHttpContext Parameter nicht und geben sofort ERROR_NOT_SUPPORTED zurück.

Hinweise für Implementierer

IGlobalTraceEventProvider-Implementierer sind für die Speicherverwaltung mit diesen Daten verantwortlich; Daher müssen Implementierer, die die dynamische Speicherbelegung verwenden, IGlobalTraceEventProvider den IHttpContext Zeiger freigeben oder aufrufendelete, wenn er nicht mehr benötigt wird.

Hinweise für Aufrufer

IGlobalTraceEventProvider-Implementierer sind für die Speicherverwaltung mit diesen Daten verantwortlich; IGlobalTraceEventProvider Daher dürfen Clients den zurückgegebenen IHttpContext Zeiger nicht freigeben oder aufrufendelete, wenn diese Daten nicht mehr benötigt werden.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie ein globales Modul erstellt wird, das auf GL_TRACE_EVENT Ereignisse lauscht und eine HTTP_TRACE_CONFIGURATION Struktur deklariert und initialisiert, die nach Ereignissen filtert. Das Modul ruft dann den IHttpContext Zeiger durch Aufrufen der GetCurrentHttpRequestContext -Methode ab.

#pragma warning( disable : 4290 )
#pragma warning( disable : 4530 )

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <tchar.h>
#include <initguid.h>
#include <httptrace.h>
#include <httpserv.h>
#include <httpcach.h>

// The CGlobalTraceModule class creates the CGlobalModule 
// class and registers for GL_TRACE_EVENT events.
class CGlobalContainerModule : public CGlobalModule
{
public:
    // Creates the destructor for the 
    // CGlobalTraceModule class.
    virtual ~CGlobalContainerModule()
    {

    }

    // The RegisterGlobalModule method creates and registers 
    // a new CGlobalTraceModule for GL_TRACE_EVENT events.
    // dwServerVersion: the current server version.
    // pModuleInfo: the current IHttpModuleRegistrationInfo pointer.
    // pGlobalInfo: the current IHttpServer pointer.
    // return: ERROR_NOT_ENOUGH_MEMORY if the heap is out of 
    // memory; otherwise, the value from the call to the 
    // SetGlobalNotifications method on the pModuleInfo pointer.
    static HRESULT RegisterGlobalModule
    (
        DWORD dwServerVersion,
        IHttpModuleRegistrationInfo* pModuleInfo,
        IHttpServer* pGlobalInfo
    )
    {        
        // The IHttpModuleRegistrationInfo 
        // pointermust not be NULL.
        if (NULL == pModuleInfo)
        {
            return E_INVALIDARG;
        }

        // Get the HTTP_MODULE_ID from the 
        // IHttpModuleRegistrationInfo pointer.
        HTTP_MODULE_ID moduleId = 
            pModuleInfo->GetId();

        // The HTTP_MODULE_ID pointer 
        // must not be NULL.
        if (NULL == moduleId)
        {
            return E_INVALIDARG;
        }

        // Create a new CGlobalContainerModule pointer
        // using the HTTP_MODULE_ID from the 
        // IHttpModuleRegistrationInfo pointer.
        CGlobalContainerModule* containerModule = 
            new CGlobalContainerModule(moduleId);

        // Return an out-of-memory error if the containerModule 
        // is NULL after the call to the new operator.
        if (NULL == containerModule)
        {            
            return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
        }                                          

        // Attempt to set global notification 
        // for an GL_TRACE_EVENT event by using 
        // the traceModule as a listener.
        HRESULT hr = pModuleInfo->SetGlobalNotifications
            (containerModule, GL_TRACE_EVENT);

        // Return the HRESULT from the call to 
        // the SetGlobalNotifications method.        
        return hr;
    }

    // The OnGlobalTraceEvent method is the callback
    // method for GL_TRACE_EVENT events in the pipeline.
    // pProvider: the IGlobalTraceEventProvider pointer.
    // return: GL_NOTIFICATION_CONTINUE.
    virtual 
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalTraceEvent
    (
        IN IGlobalTraceEventProvider* pProvider
    )
    {
        // If the IGlobalTraceEventProvider pointer 
        // is NULL, return GL_NOTIFICATION_CONTINUE.
        if (NULL == pProvider)
        {
            return GL_NOTIFICATION_CONTINUE;
        }

        // Declare an IHttpContext pointer.
        IHttpContext* httpContext = NULL;

        // Declare an HRESULT and initialize
        // the HRESULT to E_FAIL.
        HRESULT hr = E_FAIL;

        // Call the GetCurrentHttpRequestContext
        // method on the IGlobalTraceEventProvider
        // pointer.
        hr = pProvider->GetCurrentHttpRequestContext(&httpContext);

        // Return GL_NOTIFICATION_CONTINUE.
        return GL_NOTIFICATION_CONTINUE;
    }

    // The Terminate method is required for
    // non-abstract CGlobalTraceModule classes.
    // This method calls delete on this.
    virtual VOID Terminate(VOID)
    {
        delete this;
    }
    // Creates the constructor for the CGlobalTraceModule 
    // class. This constructor initializes the CEventWriter
    // to write to the application event log.
    // moduleId: the current module identifier.
    CGlobalContainerModule(HTTP_MODULE_ID moduleId)        
    {
        m_moduleId = moduleId;
    }
private:
    // Specify the HTTP_MODULE_ID
    // for this module.
    HTTP_MODULE_ID m_moduleId;
};

// The RegisterModule method is the 
// main entry point for the DLL.
// dwServerVersion: the current server version.
// pModuleInfo: the current 
// IHttpModuleRegistrationInfo pointer.
// pGlobalInfo: the current IHttpServer pointer.
// return: the value returned by calling the
// CGlobalContainerModule::RegisterGlobalModule
// method.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo* pModuleInfo,
    IHttpServer* pGlobalInfo
)
{        
    // Call the static method for initialization.
    return CGlobalContainerModule::RegisterGlobalModule            
        (dwServerVersion, 
         pModuleInfo, 
         pGlobalInfo);             
}

Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen, oder Sie können das Modul mithilfe des Schalters /EXPORT:RegisterModule kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Request-Level HTTP-Moduls mithilfe von nativem Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) Aufrufkonvention verwenden, anstatt die Aufrufkonvention 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 unter Windows Server 2012 – IIS 8.5 unter Windows Server 2012 R2 – IIS 10.0 unter 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

IGlobalTraceEventProvider-Schnittstelle

Freigeben über