Метод IHttpContext::GetRootContext

Извлекает указатель на корневой контекст для текущего контекста.

Синтаксис

virtual IHttpContext* GetRootContext(  
   VOID  
) const = 0;  

Параметры

Этот метод не принимает параметров.

Возвращаемое значение

Указатель на интерфейс IHttpContext .

Комментарии

Метод GetRootContext извлекает указатель на IHttpContext интерфейс для корневого контекста текущего запроса. Например, если модуль HTTP создает дочерний контекст с помощью метода CloneContext , метод может помочь определить, GetRootContext обрабатывается ли модуль в корневом или дочернем контексте.

Пример

В следующем примере кода показано, как использовать GetRootContext метод для создания http-модуля, который извлекает корневой контекст для запроса. Модуль сравнивает корневой контекст с NULL и текущим контекстом запроса, чтобы определить, отличается ли корневой контекст от текущего контекста. Затем модуль возвращает сообщение веб-клиенту и завершает работу.

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

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

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

        // Retrieve a pointer to the root context.
        IHttpContext * pRootContext = pHttpContext->GetRootContext();

        // Compare the root context and return a message to the client.
        if (pRootContext == NULL) WriteResponseMessage(
            pHttpContext, "The root context is null.");
        else if (pRootContext == pHttpContext) WriteResponseMessage(
            pHttpContext, "The current context equals the root context.");
        else WriteResponseMessage(
            pHttpContext, "The root context differs from the current context.");

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }
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 );

    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

Модуль должен экспортировать функцию RegisterModule . Эту функцию можно экспортировать, создав файл определения модуля (DEF) для проекта, или скомпилировать модуль с помощью /EXPORT:RegisterModule параметра . Дополнительные сведения см. в разделе Пошаговое руководство. Создание модуля HTTP Request-Level с помощью машинного кода.

При необходимости можно компилировать код с помощью соглашения о __stdcall (/Gz) вызовах вместо явного объявления соглашения о вызовах для каждой функции.

Требования

См. также:

Интерфейс IHttpContext
Метод IHttpContext::CloneContext
Метод IHttpContext::GetParentContext