Метод IHttpResponse::Redirect

Статья
07/19/2023

Перенаправляет клиент по указанному URL-адресу.

Синтаксис

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

Параметры

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 метод автоматически перенаправляет клиент на URL-адрес, указанный параметром pszUrl . Если fResetStatusCode имеет значение false, Redirect метод возвращает СООБЩЕНИЕ HTML о том, что URL-адрес перемещен в новое расположение. Если URL-адрес, указанный pszUrl параметром, является относительным путем, URL-адрес будет преобразован в абсолютный URL-адрес в домене запроса.

Примечание

Если после вызова Redirect метода не вернуть RQ_NOTIFICATION_FINISH_REQUEST из модуля, Redirect метод не будет автоматически очищать буфер ответов. В этом случае последующая обработка может добавить сведения в буфер ответов, и вы можете получить непредвиденные результаты, если не очистить ответ вручную.

Примечание

Метод Redirect не сбрасывает сущность ответа в клиент, и все данные в ответе будут удалены при вызове Redirect метода . Если ответ уже был удален на клиент, службы IIS отправят клиенту существующие заголовки и данные, а Redirect метод не перенаправит клиент на новый URL-адрес.

Пример

В следующем примере кода показано, как использовать Redirect метод для создания модуля HTTP, который перенаправляет клиент на относительный 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 параметра . Дополнительные сведения см. в разделе Пошаговое руководство. Создание модуля HTTP Request-Level с помощью машинного кода.

При необходимости можно компилировать код с помощью соглашения о __stdcall (/Gz) вызовах вместо явного объявления соглашения о вызовах для каждой функции.

Требования

Тип	Описание
клиент	— IIS 7.0 в Windows Vista — IIS 7.5 в Windows 7 — IIS 8.0 в Windows 8 — IIS 10.0 в Windows 10
Сервер	— IIS 7.0 в Windows Server 2008 — IIS 7.5 в Windows Server 2008 R2 — IIS 8.0 в Windows Server 2012 — IIS 8.5 в Windows Server 2012 R2 — IIS 10.0 в Windows Server 2016
Продукт	— 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
Заголовок	Httpserv.h

См. также:

Интерфейс IHttpResponse

Поделиться через