IHttpModuleContextContainer::GetModuleContext, méthode

Retourne le contexte stocké à partir du conteneur de contexte.

Syntaxe

virtual IHttpStoredContext* GetModuleContext(  
   IN HTTP_MODULE_ID moduleId  
) = 0;  

Paramètres

moduleId
[IN] Pointeur HTTP_MODULE_ID .

Valeur renvoyée

Pointeur vers un IHttpStoredContext ; sinon, NULL.

Remarques

Les pointeurs CGlobalModule ou CHttpModule s’inscrivent pour différents événements définis dans le fichier d’en-tête Httpserv.h. Pour plus d’informations, consultez Constantes de traitement des demandes. Par le biais de l’une de ces méthodes, vous pouvez récupérer des virtual pointeurs IHttpModuleContextContainer à partir de différentes interfaces qui implémentent une GetModuleContextContainer méthode.

Vous pouvez définir des classes personnalisées qui implémentent l’interface IHttpStoredContext , puis créer un pointeur vers cet IHttpStoredContext implémenteur de classe en appelant l’opérateur new . Vous pouvez ensuite ajouter et récupérer ce pointeur sur un IHttpModuleContextContainer pointeur en appelant respectivement les méthodes SetModuleContext et GetModuleContext .

Lorsque le IHttpStoredContext pointeur n’est plus nécessaire, la méthode IHttpStoredContext::CleanupStoredContext est appelée en interne, où l’implémenteur de la IHttpStoredContext méthode d’interface doit généralement appeler delete``this.

Remarques pour les implémenteurs

Les implémenteurs IHttpModuleContextContainer sont responsables de la gestion de la mémoire avec ces données ; Par conséquent, IHttpModuleContextContainer les implémenteurs qui utilisent l’allocation de mémoire dynamique doivent libérer ou appeler delete le IHttpStoredContext pointeur lorsqu’il n’est plus nécessaire. Si le nettoyage est nécessaire, vous pouvez appeler la méthode IHttpStoredContext::CleanupStoredContext .

Remarques pour les appelants

IHttpModuleContextContainer les implémenteurs sont responsables de la gestion de la mémoire avec ces données ; Par conséquent, IHttpModuleContextContainer les clients ne doivent pas libérer ou appeler delete sur le pointeur retourné IHttpStoredContext lorsque ces données ne sont plus nécessaires.

Exemple

L’exemple de code suivant montre comment créer un module global qui écoute les événements GL_TRACE_EVENT , puis appelle la GetModuleContext méthode pour récupérer le IHttpStoredContext pointeur.

#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);

        // If the GetCurrentHttpRequestContext 
        // method failed, or the IHttpContext
        // pointer is NULL, return GL_NOTIFICATION_CONTINUE.
        if (FAILED(hr) || (NULL == httpContext))
        {
            return GL_NOTIFICATION_CONTINUE;
        }

        // Get the IHttpModuleContextContainer
        // pointer from the IHttpContext pointer.
        IHttpModuleContextContainer* container =
            httpContext->GetModuleContextContainer();

        // If the IHttpModuleContextContainer is 
        // NULL, return GL_NOTIFICATION_CONTINUE.
        if (NULL == container)
        {
            return GL_NOTIFICATION_CONTINUE;
        }

        // Get the IHttpStoredContext pointer 
        // from the IHttpModuleContextContainer
        // pointer.
        IHttpStoredContext* storedContext =
            container->GetModuleContext(m_moduleId);

        // 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;
    }
protected:
    // 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);             
}

Spécifications

Voir aussi

IHttpModuleContextContainer, interface
IHttpModuleContextContainer::SetModuleContext, méthode