Método IHttpRequest::D eleteHeader

Exclui um cabeçalho HTTP da solicitação.

Sintaxe

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

Parâmetros

pszHeaderName
[IN] Um ponteiro para uma cadeia de caracteres que contém o nome do cabeçalho a ser excluído.

ulHeaderIndex
[IN] Um HTTP_HEADER_ID valor que especifica a ID de um cabeçalho HTTP a ser excluído.

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.

Comentários

O DeleteHeader método exclui um cabeçalho HTTP especificado da solicitação atual. Há duas versões sobrecarregadas do DeleteHeader método . Um especifica o cabeçalho usando uma cadeia de caracteres contida no pszHeaderName parâmetro . A outra sobrecarga usa um inteiro longo sem sinal contido no ulHeaderIndex parâmetro .

O nome do pszHeaderName cabeçalho especificado pelo parâmetro pode ser um cabeçalho personalizado ou um cabeçalho definido em Solicitação de Comentários (RFC) 1945, "Protocolo de Transferência de Hipertexto -- HTTP/1.0" ou RFC 2616, "Protocolo de Transferência de Hipertexto -- HTTP/1.1".

Observação

O pszHeaderName parâmetro não pode ser definido como null.

O ulHeaderIndex parâmetro especifica a ID de um cabeçalho HTTP listado na HTTP_HEADER_ID enumeração , que contém vários cabeçalhos HTTP comuns.

Observação

A HTTP_HEADER_ID enumeração é definida no arquivo de cabeçalho Http.h.

Exemplo

O exemplo de código a seguir ilustra como usar ambas as versões do DeleteHeader método para criar um módulo HTTP que remove os User-Agent cabeçalhos HTTP e Accept-Language da solicitação.

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

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

IHttpRequest Interface
Método IHttpRequest::GetHeader
Método IHttpRequest::SetHeader