ISendResponseProvider::GetHeadersBeingSent, méthode

Récupère une valeur qui indique si les en-têtes HTTP sont retournés.

Syntaxe

virtual BOOL GetHeadersBeingSent(  
   VOID  
) const = 0;  

Paramètres

Cette méthode ne prend aucun paramètre.

Valeur renvoyée

true si des en-têtes sont retournés ; sinon, false.

Remarques

La GetHeadersBeingSent méthode récupère le status qui indique si les en-têtes HTTP sont retournés avec la réponse actuelle. Par exemple, si les en-têtes ont été supprimés par la méthode IHttpResponse::SuppressHeaders , GetHeadersBeingSent retourne false.

Exemple

L’exemple de code suivant montre comment créer un module HTTP qui utilise la IHttpResponse::SuppressHeaders méthode pour supprimer l’ensemble par défaut d’en-têtes HTTP et crée un nouvel ensemble d’en-têtes HTTP de base. Le module appelle ensuite la GetHeadersBeingSent méthode pour récupérer les status des en-têtes envoyés. Enfin, le module crée un corps de réponse avec le status des en-têtes et retourne ces informations à un client Web.

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        // Clear the existing response.
        pHttpContext->GetResponse()->Clear();

        // Suppress the server headers.
        pHttpContext->GetResponse()->SuppressHeaders();

        // Create string buffers for the raw HTTP response.
        char szHeaders[256];
        char szBody[256];
        
        // Create the raw HTTP body.
        sprintf_s(szBody,255,"Headers being sent: %s",
            (pProvider->GetHeadersBeingSent()==TRUE)?"Yes":"No");

        // Create the raw HTTP headers.
        sprintf_s(szHeaders,255,"HTTP/1.1 200 OK\r\n" \
            "Content-type: text/plain\r\n" \
            "Content-length: %u\r\n\r\n",strlen(szBody));
        
        // Return the raw HTTP response to the Web client.
        WriteResponseMessage(pHttpContext,szHeaders,szBody);

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }

private:

    // Create a utility method that inserts a name/value pair into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszName,
        PCSTR pszValue
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create a data chunk.
        HTTP_DATA_CHUNK dataChunk;
        // Set the chunk to a chunk in memory.
        dataChunk.DataChunkType = HttpDataChunkFromMemory;
        // Buffer for bytes written of data chunk.
        DWORD cbSent;

        // Set the chunk to the first buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszName;
        // Set the chunk size to the first buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszName);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Set the chunk to the second buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszValue;
        // Set the chunk size to the second buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszValue);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

// 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_SEND_RESPONSE,
        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

ISendResponseProvider, interface
IHttpResponse::GetHeadersSuppressed, méthode
IHttpResponse::SuppressHeaders, méthode