Método IHttpRequest::SetHeader

Artigo
07/19/2023

Define ou acrescenta o valor de um cabeçalho de solicitação HTTP especificado.

Sintaxe

virtual HRESULT SetHeader(  
   IN PCSTR pszHeaderName,  
   IN PCSTR pszHeaderValue,  
   IN USHORT cchHeaderValue,  
   IN BOOL fReplace  
) = 0;  
  
virtual HRESULT SetHeader(  
   IN HTTP_HEADER_ID ulHeaderIndex,  
   IN PCSTR pszHeaderValue,  
   IN USHORT cchHeaderValue,  
   IN BOOL fReplace  
) = 0;

Parâmetros

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

ulHeaderIndex
[IN] A ID de um cabeçalho HTTP a ser definido.

pszHeaderValue
[IN] Um ponteiro para uma cadeia de caracteres que contém o valor do cabeçalho a ser definido.

cchHeaderValue
[IN] O comprimento, em caracteres, do valor do cabeçalho, não incluindo o caractere \0.

fReplace
[IN] true para substituir o cabeçalho existente; caso contrário, false.

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.
ERROR_INVALID_DATA	Indica que os dados não são válidos (por exemplo, os dados no cabeçalho são muito longos).
ERROR_INVALID_PARAMETER	Indica que o parâmetro especificado não é válido (por exemplo, o parâmetro é NULL).
ERROR_NOT_ENOUGH_MEMORY	Indica que não há memória suficiente para executar a operação.

Comentários

O SetHeader método define o valor de um cabeçalho HTTP para a solicitação atual. Há duas versões sobrecarregadas do SetHeader método . Um permite especificar 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 .

Observação

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

Se o fReplace parâmetro for true, o valor do cabeçalho especificado substituirá o valor de cabeçalho existente se o cabeçalho existir. Se fReplace for false, você deverá acrescentar o valor de cabeçalho especificado ao cabeçalho existente e separar o valor do próprio cabeçalho com uma vírgula.

Exemplo

O exemplo de código a seguir demonstra como usar as duas sobrecargas do SetHeader método para criar um módulo HTTP que substitui o HTTP User-Agent e Accept-Language os cabeçalhos por novos valores.


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

        // Specify the "User-Agent" header name.
        char szHeaderName[] = "User-Agent";
        // Specify the "User-Agent" header value.
        char szUserAgent[] = "Test Browser";
        // Specify the "Accept-Language" header value.
        char szAcceptLanguage[] = "en-ie";

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

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Replace the "User-Agent" header.
            hr = pHttpRequest->SetHeader(
                szHeaderName,szUserAgent,
                (USHORT)strlen(szUserAgent),true);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }

            // Replace the "Accept-language" header.
            hr = pHttpRequest->SetHeader(
                HttpHeaderAcceptLanguage,szAcceptLanguage,
                (USHORT)strlen(szAcceptLanguage),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;
        }            
    }
/* MERGEFORMAT 16 Aug 07  5:41 PM */
    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::D eleteHeader
Método IHttpRequest::GetHeader

Compartilhar via

Método IHttpRequest::SetHeader

Sintaxe

Parâmetros

Valor Retornado

Comentários

Exemplo

Requisitos

Consulte Também

Comentários

Recursos adicionais