Метод IHttpRequest::D eleteHeader

Статья
07/19/2023

Удаляет заголовок HTTP из запроса.

Синтаксис

virtual HRESULT DeleteHeader(  
   IN PCSTR pszHeaderName  
) = 0;  
  
virtual HRESULT DeleteHeader(  
   IN HTTP_HEADER_ID ulHeaderIndex  
) = 0;

Параметры

pszHeaderName
[IN] Указатель на строку, содержащую имя удаляемого заголовка.

ulHeaderIndex
[IN] Значение HTTP_HEADER_ID типа , указывающее идентификатор удаляемого http-заголовка.

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

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

Значение	Описание:
S_OK	Указывает, что операция выполнена успешно.

Метод DeleteHeader удаляет указанный заголовок HTTP из текущего запроса. Существует две перегруженные DeleteHeader версии метода . Один из них задает заголовок с помощью строки, содержащейся в параметре pszHeaderName . Другая перегрузка использует длинное целое число без знака, содержащееся в параметре ulHeaderIndex .

Имя заголовка, указанное pszHeaderName параметром, может быть пользовательским заголовком или заголовком, определенным в разделе Запрос комментариев (RFC) 1945, "Протокол передачи гипертекстов - HTTP/1.0" или RFC 2616, "Протокол передачи гипертекста - HTTP/1.1".

Примечание

Параметру pszHeaderName не может быть присвоено значение null.

Параметр ulHeaderIndex задает идентификатор заголовка HTTP, указанного в перечислении HTTP_HEADER_ID , который содержит несколько общих заголовков HTTP.

Примечание

Перечисление HTTP_HEADER_ID определяется в файле заголовка Http.h.

Пример

В следующем примере кода показано, как использовать обе версии DeleteHeader метода для создания модуля HTTP, который удаляет заголовки User-Agent и Accept-Language HTTP из запроса.

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

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

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

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Delete the "User-Agent" header.
            hr = pHttpRequest->DeleteHeader("User-Agent");
            // test for an error
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
            // Delete the "Accept-language" header.
            // (Use values from HTTP_HEADER_ID in the Http.h file.)
            hr = pHttpRequest->DeleteHeader(HttpHeaderAcceptLanguage);
            // 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

См. также:

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

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