Método IHttpResponse::Redirect

Redireciona o cliente para uma URL especificada.

Sintaxe

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

Parâmetros

pszUrl
[IN] Um ponteiro para uma cadeia de caracteres que contém a URL para redirecionamento.

fResetStatusCode
[IN] true para definir o código http status como um 302 status; false para retornar uma mensagem HTML que indica que a página foi movida.

fIncludeParameters
[IN] true para passar a cadeia de caracteres de consulta da solicitação HTTP original para a URL redirecionada; caso contrário, false.

Valor Retornado

Um HRESULT. Os possíveis valores incluem, mas sem limitação, aqueles na tabela a seguir.

Valor	Descrição
S_OK	Indica que a operação foi bem-sucedida.
ERROR_INVALID_PARAMETER	Indica que um parâmetro especificado não era válido.
ERROR_NOT_ENOUGH_MEMORY	Indica que não há memória suficiente para executar a operação.

Comentários

Quando o fResetStatusCode parâmetro é true, o Redirect método redireciona automaticamente um cliente para uma URL especificada pelo pszUrl parâmetro . Quando fResetStatusCode é false, o Redirect método retorna uma mensagem HTML informando que a URL foi movida para o novo local. Se a URL especificada pelo pszUrl parâmetro for um caminho relativo, a URL será convertida em uma URL absoluta dentro do domínio de solicitação.

Observação

Se você não retornar RQ_NOTIFICATION_FINISH_REQUEST do módulo depois de chamar o Redirect método, o Redirect método não limpará automaticamente o buffer de resposta. Nessa situação, o processamento subsequente pode adicionar informações ao buffer de resposta e você poderá receber resultados inesperados se não limpar manualmente a resposta.

Observação

O Redirect método não libera a entidade de resposta para o cliente e todos os dados na resposta serão removidos quando você chamar o Redirect método . Se a resposta já tiver sido liberada para o cliente, o IIS terá enviado os cabeçalhos e dados existentes para o cliente e o Redirect método não redirecionará o cliente para a nova URL.

Exemplo

O exemplo de código a seguir demonstra como usar o Redirect método para criar um módulo HTTP que redireciona um cliente para uma URL relativa no servidor 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 );

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

Seu módulo deve exportar a função RegisterModule . Você pode exportar essa função criando um arquivo de definição de módulo (.def) para seu projeto ou pode compilar o módulo usando a opção /EXPORT:RegisterModule . Para obter mais informações, consulte Passo a passo: criando um módulo HTTP Request-Level usando código nativo.

Opcionalmente, você pode compilar o código usando a __stdcall (/Gz) convenção de chamada em vez de declarar explicitamente a convenção de chamada para cada função.

Requisitos

Type	Descrição
Cliente	- IIS 7.0 no Windows Vista - IIS 7.5 no Windows 7 - IIS 8.0 no Windows 8 - IIS 10.0 no Windows 10
Servidor	- IIS 7.0 no Windows Server 2008 - IIS 7.5 no Windows Server 2008 R2 - IIS 8.0 no Windows Server 2012 - IIS 8.5 no Windows Server 2012 R2 - IIS 10.0 no Windows Server 2016
Produto	- 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
parâmetro	Httpserv.h

Consulte Também

IHttpResponse Interface