IHttpContext：：CloneContext 方法

项目
07/19/2023

创建当前请求上下文的克隆。

语法

virtual HRESULT CloneContext(  
   IN DWORD dwCloneFlags,  
   OUT IHttpContext** ppHttpContext  
) = 0;

parameters

dwCloneFlags
[IN]一个 DWORD 包含克隆标志的。

ppHttpContext
[OUT]指向 IHttpContext 的取消引用指针。

返回值

HRESULT。可能的值包括（但并不限于）下表中的项。

值	说明
S_OK	指示操作成功。
ERROR_INVALID_PARAMETER	指示指定的参数无效。
ERROR_NOT_ENOUGH_MEMORY	指示内存不足，无法执行操作。

备注

方法 CloneContext 创建当前请求上下文的克隆。可以通过在参数中 dwCloneFlags 指定适当的标志来控制克隆行为。下表列出了这些标志的可能值。

值	说明
CLONE_FLAG_BASICS	克隆 URL、查询字符串和 HTTP 方法。
CLONE_FLAG_HEADERS	克隆请求标头。
CLONE_FLAG_ENTITY	克隆实体正文。
CLONE_FLAG_NO_PRECONDITION	不要为请求包含任何“range”和“if-”标头。
CLONE_FLAG_NO_DAV	不要为请求包含任何 WebDAV 标头。

创建克隆的上下文后，可以使用克隆，就像使用父上下文一样。例如，若要对与父 URL 不同的 URL 执行子请求，可以在调用父上下文的 IHttpContext：：ExecuteRequest 方法之前，使用克隆上下文的 IHttpRequest：：SetUrl 方法更改克隆上下文的 URL。

示例

下面的代码示例演示如何创建执行以下任务的 HTTP 模块：

模块注册 RQ_MAP_PATH 通知。
该模块创建包含 OnMapPath 和 OnAsyncCompletion 方法的 CHttpModule 类。
当 Web 客户端请求 URL 时，IIS 会调用模块的 OnMapPath 方法。此方法执行以下任务：
1. 测试当前请求的 URL 是具有尾部斜杠还是以 /default.aspx 结尾。如果 URL 以任一元素结尾，则模块使用 CloneContext 方法创建当前请求的克隆。
2. 调用克隆的 IHttpRequest::SetUrl 方法，将克隆的 URL 设置为 /example/default.aspx。
3. IHttpContext::ExecuteRequest调用方法以执行子请求。
4. 异步完成测试。如果异步完成处于挂起状态，则模块会将处理返回到集成的请求处理管道。否则，模块将释放克隆的上下文。
如果需要异步完成，IIS 会调用模块的 OnAsyncCompletion 方法。此方法释放克隆的上下文。
模块从内存中删除类， CHttpModule 然后退出。

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

// Create the module class.
class MyHttpModule : public CHttpModule
{

private:

    // Create a pointer for a child request.
    IHttpContext * m_pChildRequestContext;

public:

    MyHttpModule(void)
    {
        m_pChildRequestContext = NULL;
    }

    REQUEST_NOTIFICATION_STATUS
    OnMapPath(
        IN IHttpContext * pHttpContext,
        IN IMapPathProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        HRESULT hr;
        BOOL fCompletionExpected;

        // Retrieve a pointer to the URL.
        PCWSTR pwszUrl = pProvider->GetUrl();

        // Only process requests for the root.
        if (0 == wcscmp(pwszUrl,L"/") || 0 == wcscmp(pwszUrl,L"/default.aspx"))
        {            
            // Clone the current context.
            hr = pHttpContext->CloneContext(
                CLONE_FLAG_BASICS, &m_pChildRequestContext );
            
            // Test for a failure.
            if (FAILED(hr))
            {
                goto Failure;
            }
            
            // Test for an error.
            if ( NULL != m_pChildRequestContext )
            {
                // Set the URL for the child request.
                hr = m_pChildRequestContext->GetRequest()->SetUrl(
                    "/example/default.aspx",
                    (DWORD)strlen("/example/default.aspx"),false);
            
                // Test for a failure.
                if (FAILED(hr))
                {
                    goto Failure;
                }
                
                // Execute the child request.
                hr = pHttpContext->ExecuteRequest(
                    TRUE, m_pChildRequestContext,
                    0, NULL, &fCompletionExpected );
                
                // Test for a failure.
                if (FAILED(hr))
                {
                    goto Failure;
                }
                
                // Test for pending asynchronous operations.
                if (fCompletionExpected)
                {
                    return RQ_NOTIFICATION_PENDING;
                }

            }

 Failure:
            // Test for a child request.
            if (NULL != m_pChildRequestContext)
            {
                // Release the child request.
                m_pChildRequestContext->ReleaseClonedContext();
                m_pChildRequestContext = NULL;
            }
        }
        
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
    
    REQUEST_NOTIFICATION_STATUS
        OnAsyncCompletion(
        IN IHttpContext * pHttpContext,
        IN DWORD dwNotification,
        IN BOOL fPostNotification,
        IN IHttpEventProvider * pProvider,
        IN IHttpCompletionInfo * pCompletionInfo
        )
    {
        // Test for a child request.
        if (NULL != m_pChildRequestContext)
        {
            // Release the child request.
            m_pChildRequestContext->ReleaseClonedContext();
            m_pChildRequestContext = NULL;
        }
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

};

// 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_MAP_PATH,
        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
Header	Httpserv.h

另请参阅

IHttpContext 接口
 IHttpContext：：ExecuteRequest 方法
 IHttpContext：：ReleaseClonedContext 方法

通过

IHttpContext：：CloneContext 方法

语法

parameters

返回值

备注

示例

要求

另请参阅

反馈

其他资源