IPreBeginRequestProvider::GetHttpContext 方法

检索 IHttpContext 接口。

语法

virtual IHttpContext* GetHttpContext(  
   VOID  
) = 0;  

参数

此方法不采用参数。

返回值

指向 IHttpContext 的指针。

备注

方法 GetHttpContext 检索指向 IHttpContext 接口的指针,该接口允许全局级别通知访问请求的上下文。 这与请求级通知形成鲜明对比,请求级通知提供了指向接口的 IHttpContext 指针。

示例

下面的代码示例演示如何创建一个全局级别 HTTP 模块,该模块使用 GetHttpContext 函数检索指向接口的 IHttpContext 指针。 该模块调用上下文的 IHttpContext::GetSite 方法以检索指向 IHttpSite 接口的指针,然后调用 IHttpSite::GetSiteName 方法来检索正在处理请求的站点的名称。

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

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalPreBeginRequest(
        IN IPreBeginRequestProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Retrieve a pointer to the IHttpContext for the request.
        IHttpContext * pHttpContext = pProvider->GetHttpContext();
        // Test for an error.
        if (NULL != pHttpContext)
        {
            // Retrieve a pointer to an IHttpSite class.
            IHttpSite * pHttpSite = pHttpContext->GetSite();
            // Test for an error.
            if (NULL != pHttpSite)
            {
                // Retrieve the site name.
                PCWSTR pwszSiteName = pHttpSite->GetSiteName();
                // Test for an error.
                if (NULL != pwszSiteName)
                {
                    // Allocate storage for the site name.
                    char * pszSiteName =
                        (char *) pHttpContext->AllocateRequestMemory(
                        (DWORD) wcslen(pwszSiteName)+1 );
                    // Test for an error.
                    if (NULL != pszSiteName)
                    {
                        // Convert the site name.
                        wcstombs(pszSiteName,pwszSiteName,
                            wcslen(pwszSiteName));
                        // Create an array of strings.
                        LPCSTR szBuffer[2] = {"Site Name",""};
                        // Store the site name.
                        szBuffer[1] = pszSiteName;
                        // Write the strings to the Event Viewer.
                        WriteEventViewerLog(szBuffer,2);
                    }
                }
            }
        }
        // Return processing to the pipeline.
        return GL_NOTIFICATION_CONTINUE;
    }

    VOID Terminate()
    {
        // Remove the class from memory.
        delete this;
    }

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

    ~MyGlobalModule()
    {
        // Test if the handle for the Event Viewer is open.
        if (NULL != MyGlobalModule::m_hEventLog)
        {
            DeregisterEventSource( MyGlobalModule::m_hEventLog );
            MyGlobalModule::m_hEventLog = NULL;
        }
    }

private:

    // Handle for the Event Viewer.
    HANDLE m_hEventLog;

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

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Create an instance of the global module class.
    MyGlobalModule * pGlobalModule = new MyGlobalModule;
    // Test for an error.
    if (NULL == pGlobalModule)
    {
        return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
    }
    // Set the global notifications and exit.
    return pModuleInfo->SetGlobalNotifications(
        pGlobalModule, GL_PRE_BEGIN_REQUEST );
}

模块必须导出 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
Header Httpserv.h

另请参阅

IPreBeginRequestProvider 接口