Метод IHttpRequest::SetUrl

Статья
03/16/2023

Изменяет URL-адрес запроса.

Синтаксис

virtual HRESULT SetUrl(  
   IN PCWSTR pszUrl,  
   IN DWORD cchUrl,  
   IN BOOL fResetQueryString  
) = 0;  
  
virtual HRESULT SetUrl(  
   IN PCSTR pszUrl,  
   IN DWORD cchUrl,  
   IN BOOL fResetQueryString  
) = 0;

Параметры

pszUrl
[IN] Указатель на строку, содержащую задается URL-адрес.

cchUrl
[IN] Длина (в символах) URL-адреса, заданного параметром pszUrl.

fResetQueryString
[IN] true для сброса существующей строки запроса; в противном случае — false.

Возвращаемое значение

Объект HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.

Значение	Описание:
S_OK	Указывает, что операция прошла успешно.
ERROR_INVALID_PARAMETER	Указывает, что указанный параметр недопустим (например, указанный URL-адрес слишком длинный).
ERROR_NOT_ENOUGH_MEMORY	Указывает, что для выполнения операции недостаточно памяти.

Метод SetUrl изменяет URL-адрес для текущего запроса. Существует две перегруженные SetUrl версии метода . Один из них позволяет указать заголовок с помощью указателя на строку. Другая перегрузка использует указатель на широкую строку.

Последующие функции обработки запросов и операции ведения журнала будут обрабатывать новый URL-адрес так, как если бы клиент запросил URL-адрес. Таким образом, все ошибки, вызванные изменением URL-адреса, будут возвращены клиенту. Например, если новый URL-адрес не существует, веб-сервер вернет ошибку HTTP 404.

Предупреждение

Метод SetUrl вызывается после сбора исходных параметров для запроса, поэтому последующая обработка запроса может не знать об измененных URL-адресах. Например, при получении переменной сервера URL-адреса будет отражен исходный запрос, а не измененный URL-адрес. Разработчики должны вызывать метод IHttpContext::ExecuteRequest вместо SetUrl , чтобы выполнить запрос через полный конвейер. Метод SetUrl не следует использовать для перезаписи URL-адресов.

Примечание

В отличие от метода IHttpResponse::Redirect , SetUrl метод не перенаправляет клиент на новый URL-адрес.

Примечание

Необходимо вызвать SetUrl метод до первого события в конвейере обработки запросов, интегрированного с HTTP. SetUrl Вызов метода из обработчика OnPostBeginRequest приводит к неопределенному поведению.

Пример

В следующем примере кода показано, как использовать SetUrl метод для изменения запрошенного 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
    )
    {
        HRESULT hr;

        // Retrieve a pointer to the request.
        IHttpRequest * pHttpRequest = pHttpContext->GetRequest();

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Create a buffer with an example URL.
            PCSTR pszBuffer = "/example/default.aspx";
            // Set the URL for the request.
            hr = pHttpRequest->SetUrl(
                pszBuffer,(DWORD)strlen(pszBuffer),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
    );
}

Требования

Тип	Описание
клиент	— 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

См. также:

Интерфейс IHttpRequest
Метод IHttpRequest::GetUrlChanged

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