IHttpContext：：GetRootContext 方法

检索指向当前上下文的根上下文的指针。

语法

virtual IHttpContext* GetRootContext(  
   VOID  
) const = 0;  

参数

此方法不采用参数。

返回值

指向 IHttpContext 接口的指针。

备注

方法 GetRootContext 检索指向 IHttpContext 当前请求根上下文的 接口的指针。 例如，如果 HTTP 模块使用 CloneContext 方法创建子上下文， GetRootContext 则 该方法可以帮助确定模块是在根上下文上还是在子上下文上进行处理。

注意

当当前上下文是根上下文时 GetRootContext ， 方法将返回 NULL。

示例

下面的代码示例演示如何使用 GetRootContext 方法创建检索请求的根上下文的 HTTP 模块。 该模块将根上下文与 NULL 和当前请求上下文进行比较，以确定根上下文是否不同于当前上下文。 然后，该模块向 Web 客户端返回一条消息并退出。

#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 。 有关详细信息，请参阅 演练：使用本机代码创建Request-Level HTTP 模块。

可以选择使用调用约定编译代码， __stdcall (/Gz) 而不是为每个函数显式声明调用约定。

要求

类型	说明
客户端	- Windows Vista 上的 IIS 7.0 - Windows 7 上的 IIS 7.5 - Windows 8 上的 IIS 8.0 - Windows 10 上的 IIS 10.0
服务器	- Windows Server 2008 上的 IIS 7.0 - Windows Server 2008 R2 上的 IIS 7.5 - Windows Server 2012 上的 IIS 8.0 - Windows Server 2012 R2 上的 IIS 8.5 - Windows Server 2016 上的 IIS 10.0
产品	- 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
产品	IIS 7.0、IIS 7.5、IIS Express 7.5、IIS 8.0
Header	Httpserv.h

另请参阅

IHttpContext 接口
IHttpContext：：CloneContext 方法
IHttpContext：：GetParentContext 方法