Metodo IHttpRequest::SetHeader

Articolo
07/19/2023

Imposta o aggiunge il valore di un'intestazione di richiesta HTTP specificata.

Sintassi

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;

Parametri

pszHeaderName
[IN] Puntatore a una stringa contenente il nome dell'intestazione HTTP da impostare.

ulHeaderIndex
[IN] ID di un'intestazione HTTP da impostare.

pszHeaderValue
[IN] Puntatore a una stringa contenente il valore dell'intestazione da impostare.

cchHeaderValue
[IN] Lunghezza, in caratteri, del valore dell'intestazione, non incluso il carattere \0.

fReplace
[IN] true per sovrascrivere l'intestazione esistente; in caso contrario, false.

Valore restituito

Oggetto HRESULT. I valori possibili includono, ma non sono limitati a, quelli indicati nella tabella seguente.

Valore	Descrizione
S_OK	Indica che l'operazione ha avuto esito positivo.
ERROR_INVALID_DATA	Indica che i dati non sono validi, ad esempio i dati nell'intestazione sono troppo lunghi.
ERROR_INVALID_PARAMETER	Indica che il parametro specificato non è valido, ad esempio il parametro è NULL.
ERROR_NOT_ENOUGH_MEMORY	Indica che la memoria non è sufficiente per eseguire l'operazione.

Commenti

Il SetHeader metodo imposta il valore di un'intestazione HTTP per la richiesta corrente. Esistono due versioni di overload del SetHeader metodo. Uno consente di specificare l'intestazione usando una stringa contenuta nel pszHeaderName parametro. L'altro overload usa un intero lungo senza segno contenuto nel ulHeaderIndex parametro.

Il nome dell'intestazione specificato dal pszHeaderName parametro può essere un'intestazione personalizzata o un'intestazione definita in Request for Comments (RFC) 1945, "Hypertext Transfer Protocol - HTTP/1.0" o RFC 2616, "Hypertext Transfer Protocol - HTTP/1.1".

Nota

Impossibile impostare il pszHeaderName parametro su NULL.

Il ulHeaderIndex parametro specifica l'ID di un'intestazione HTTP elencata nell'enumerazione HTTP_HEADER_ID .

Nota

L'enumerazione HTTP_HEADER_ID è definita nel file di intestazione Http.h.

Se il parametro è true, il fReplace valore dell'intestazione specificato sostituirà il valore dell'intestazione esistente se l'intestazione esiste. Se fReplace è false, è necessario aggiungere il valore dell'intestazione specificato all'intestazione esistente e separare il valore dall'intestazione stessa con una virgola.

Esempio

Nell'esempio di codice seguente viene illustrato come usare entrambi gli overload del SetHeader metodo per creare un modulo HTTP che sostituisce http User-Agent e Accept-Language intestazioni con nuovi valori.


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

Il modulo deve esportare la funzione RegisterModule . È possibile esportare questa funzione creando un file di definizione del modulo (con estensione def) per il progetto oppure è possibile compilare il modulo usando l'opzione /EXPORT:RegisterModule . Per altre informazioni, vedere Procedura dettagliata: Creazione di un modulo HTTP Request-Level tramite codice nativo.

Facoltativamente, è possibile compilare il codice usando la __stdcall (/Gz) convenzione chiamante anziché dichiarare esplicitamente la convenzione chiamante per ogni funzione.

Requisiti

Tipo	Descrizione
Client	- IIS 7.0 in Windows Vista - IIS 7.5 in Windows 7 - IIS 8.0 in Windows 8 - IIS 10.0 in Windows 10
Server	- IIS 7.0 in Windows Server 2008 - IIS 7.5 in Windows Server 2008 R2 - IIS 8.0 in Windows Server 2012 - IIS 8.5 in Windows Server 2012 R2 - IIS 10.0 in Windows Server 2016
Prodotto	- 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
Intestazione	Httpserv.h

Vedere anche

Interfaccia IHttpRequest
Metodo IHttpRequest::D eleteHeader
Metodo IHttpRequest::GetHeader

Condividi tramite