IHttpRequest::SetHeader, méthode

Définit ou ajoute la valeur d’un en-tête de requête HTTP spécifié.

Syntaxe

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;  

Paramètres

pszHeaderName
[IN] Pointeur vers une chaîne qui contient le nom de l’en-tête HTTP à définir.

ulHeaderIndex
[IN] ID d’un en-tête HTTP à définir.

pszHeaderValue
[IN] Pointeur vers une chaîne qui contient la valeur de l’en-tête à définir.

cchHeaderValue
[IN] Longueur, en caractères, de la valeur d’en-tête, sans le caractère \0.

fReplace
[IN] true pour remplacer l’en-tête existant ; sinon, false.

Valeur renvoyée

Élément HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Remarques

La SetHeader méthode définit la valeur d’un en-tête HTTP pour la requête actuelle. Il existe deux versions surchargées de la SetHeader méthode. L’une d’elles vous permet de spécifier l’en-tête à l’aide d’une chaîne contenue dans le pszHeaderName paramètre. L’autre surcharge utilise un entier long non signé contenu dans le ulHeaderIndex paramètre .

Le nom d’en-tête spécifié par le pszHeaderName paramètre peut être un en-tête personnalisé ou un en-tête défini dans Request for Comments (RFC) 1945, « Hypertext Transfer Protocol -- HTTP/1.0 » ou RFC 2616, « Hypertext Transfer Protocol -- HTTP/1.1 ».

Le ulHeaderIndex paramètre spécifie l’ID d’un en-tête HTTP répertorié dans l’énumération HTTP_HEADER_ID .

Si le fReplace paramètre est true, la valeur d’en-tête spécifiée remplace la valeur d’en-tête existante si l’en-tête existe. Si fReplace est false, vous devez ajouter la valeur d’en-tête spécifiée à l’en-tête existant et séparer la valeur de l’en-tête lui-même par une virgule.

Exemple

L’exemple de code suivant montre comment utiliser les deux surcharges de la SetHeader méthode pour créer un module HTTP qui remplace le HTTP User-Agent et Accept-Language les en-têtes par de nouvelles valeurs.

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

Votre module doit exporter la fonction RegisterModule . Vous pouvez exporter cette fonction en créant un fichier de définition de module (.def) pour votre projet, ou vous pouvez compiler le module à l’aide du /EXPORT:RegisterModule commutateur. Pour plus d’informations, consultez Procédure pas à pas : création d’un module HTTP Request-Level à l’aide de code natif.

Vous pouvez éventuellement compiler le code à l’aide de la __stdcall (/Gz) convention d’appel au lieu de déclarer explicitement la convention d’appel pour chaque fonction.

Spécifications

Voir aussi

IHttpRequest, interface
IHttpRequest::D eleteHeader, méthode
IHttpRequest::GetHeader, méthode