IHttpResponse：：Redirect 方法

将客户端重定向到指定的 URL。

语法

virtual HRESULT Redirect(  
   IN PCSTR pszUrl,  
   IN BOOL fResetStatusCode = TRUE,  
   IN BOOL fIncludeParameters = FALSE  
) = 0;  

parameters

pszUrl
[IN]指向包含重定向 URL 的字符串的指针。

fResetStatusCode
[IN] true 将 HTTP 状态代码设置为 302 状态; false 返回指示页面已移动的 HTML 消息。

fIncludeParameters
[IN] true 将查询字符串从原始 HTTP 请求传递到重定向 URL;否则为 false。

返回值

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

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

备注

fResetStatusCode当 参数为 true时， Redirect 方法会自动将客户端重定向到 参数pszUrl指定的 URL。 当 为 false时fResetStatusCode，Redirect该方法返回一条 HTML 消息，指出 URL 已移动到新位置。 如果 参数指定的 pszUrl URL 是相对路径，则 URL 将转换为请求域中的绝对 URL。

注意

如果在调用 Redirect 方法后未从模块返回RQ_NOTIFICATION_FINISH_REQUEST，该方法Redirect不会自动清除响应缓冲区。 在这种情况下，后续处理可能会向响应缓冲区添加信息，如果不手动清除响应，可能会收到意外结果。

注意

方法 Redirect 不会将响应实体刷新到客户端，并且调用 Redirect 方法时将删除响应中的任何数据。 如果已将响应刷新到客户端，IIS 会将现有标头和数据发送到客户端，并且 Redirect 该方法不会将客户端重定向到新的 URL。

示例

下面的代码示例演示如何使用 Redirect 方法创建 HTTP 模块，该模块将客户端重定向到 Web 服务器上的相对 URL。

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

        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Set the response header.
            HRESULT hr = pHttpResponse->Redirect("/example/",true,true);
            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
            }
            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

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

    // Set the request notifications and exit.
    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
Header	Httpserv.h

另请参阅

IHttpResponse 接口