IHttpResponse::Redirect (Método)

Redirige el cliente a una dirección URL especificada.

Sintaxis

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

Parámetros

pszUrl
[IN] Puntero a una cadena que contiene la dirección URL para el redireccionamiento.

fResetStatusCode
[IN] true para establecer el código de estado HTTP en un estado 302; false para devolver un mensaje HTML que indica que se ha movido la página.

fIncludeParameters
[IN] true para pasar la cadena de consulta de la solicitud HTTP original a la dirección URL redirigida; de lo contrario, false.

Valor devuelto

Una clase HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.

Value	Descripción
S_OK	Indica que la operación se realizó correctamente.
ERROR_INVALID_PARAMETER	Indica que un parámetro especificado no era válido.
ERROR_NOT_ENOUGH_MEMORY	Indica que no hay memoria suficiente para realizar la operación.

Comentarios

Cuando el fResetStatusCode parámetro es true, el Redirect método redirige automáticamente un cliente a una dirección URL especificada por el pszUrl parámetro . Cuando fResetStatusCode es false, el Redirect método devuelve un mensaje HTML que indica que la dirección URL se ha movido a la nueva ubicación. Si la dirección URL especificada por el pszUrl parámetro es una ruta de acceso relativa, la dirección URL se convertirá en una dirección URL absoluta dentro del dominio de solicitud.

Nota:

Si no devuelve RQ_NOTIFICATION_FINISH_REQUEST desde el módulo después de llamar al Redirect método , el Redirect método no borrará automáticamente el búfer de respuesta. En esta situación, el procesamiento posterior puede agregar información al búfer de respuesta y puede recibir resultados inesperados si no borra manualmente la respuesta.

Nota

El Redirect método no vacía la entidad de respuesta al cliente y los datos de la respuesta se quitarán al llamar al Redirect método . Si la respuesta ya se ha vaciado al cliente, IIS enviará los encabezados y datos existentes al cliente, y el Redirect método no redirigirá al cliente a la nueva dirección URL.

Ejemplo

En el ejemplo de código siguiente se muestra cómo usar el Redirect método para crear un módulo HTTP que redirige a un cliente a una dirección URL relativa en el 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
    );
}

El módulo debe exportar la función RegisterModule . Puede exportar esta función mediante la creación de un archivo de definición de módulo (.def) para el proyecto, o bien puede compilar el módulo mediante el /EXPORT:RegisterModule modificador . Para obtener más información, vea Tutorial: Creación de un módulo HTTP de Request-Level mediante código nativo.

Opcionalmente, puede compilar el código mediante la __stdcall (/Gz) convención de llamada en lugar de declarar explícitamente la convención de llamada para cada función.

Requisitos

Tipo	Descripción
Remoto	- IIS 7.0 en Windows Vista - IIS 7.5 en Windows 7 - IIS 8.0 en Windows 8 - IIS 10.0 en Windows 10
Servidor	- IIS 7.0 en Windows Server 2008 - IIS 7.5 en Windows Server 2008 R2 - IIS 8.0 en Windows Server 2012 - IIS 8.5 en Windows Server 2012 R2 - IIS 10.0 en Windows Server 2016
Producto	- 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
Encabezado	Httpserv.h

Consulte también

IHttpResponse (interfaz)