Método ISendResponseProvider::GetHeadersBeingSent

Recupera um valor que indica se os cabeçalhos HTTP estão sendo retornados.

Sintaxe

virtual BOOL GetHeadersBeingSent(  
   VOID  
) const = 0;  

Parâmetros

Este método não aceita parâmetros.

Valor Retornado

true se os cabeçalhos estiverem sendo retornados; caso contrário, false.

Comentários

O GetHeadersBeingSent método recupera o status que indica se os cabeçalhos HTTP estão sendo retornados com a resposta atual. Por exemplo, se os cabeçalhos tiverem sido suprimidos pelo método IHttpResponse::SuppressHeaders , GetHeadersBeingSent retornará false.

Exemplo

O exemplo de código a seguir demonstra como criar um módulo HTTP que usa o IHttpResponse::SuppressHeaders método para suprimir o conjunto padrão de cabeçalhos HTTP e cria um novo conjunto de cabeçalhos HTTP básicos. Em seguida, o módulo chama o GetHeadersBeingSent método para recuperar o status dos cabeçalhos que estão sendo enviados. Por fim, o módulo cria um corpo de resposta com o status dos cabeçalhos e retorna essas informações para um cliente 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
    );
}

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

ISendResponseProvider Interface
Método IHttpResponse::GetHeadersSuppressed
Método IHttpResponse::SuppressHeaders