Método IHttpResponse::WriteEntityChunks

Acrescenta uma ou mais estruturas HTTP_DATA_CHUNK ao corpo da resposta.

Sintaxe

virtual HRESULT WriteEntityChunks(  
   IN HTTP_DATA_CHUNK* pDataChunks,  
   IN DWORD nChunks,  
   IN BOOL fAsync,  
   IN BOOL fMoreData,  
   OUT DWORD* pcbSent,  
   OUT BOOL* pfCompletionExpected = NULL  
) = 0;  

Parâmetros

pDataChunks
[IN] Um ponteiro para uma ou mais HTTP_DATA_CHUNK estruturas.

nChunks
[IN] Um DWORD que contém o número de partes apontadas por pDataChunks.

fAsync
[IN] true se o método deve ser concluído de forma assíncrona; caso contrário, false.

fMoreData
[IN] true se mais dados devem ser enviados na resposta; false se esses forem os últimos dados.

pcbSent
[OUT] O número de bytes que foram enviados ao cliente se a chamada for concluída de forma síncrona.

pfCompletionExpected
[OUT] true se uma conclusão assíncrona estiver pendente para essa chamada; 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_PARAMETER	Indica que o parâmetro não é válido (por exemplo, o pDataChunks ponteiro é definido como NULL).
ERROR_NOT_ENOUGH_MEMORY	Indica que não há memória suficiente para executar a operação.
ERROR_ARITHMETIC_OVERFLOW	Mais de 65535 partes foram adicionadas à resposta.

Comentários

Os desenvolvedores podem usar o WriteEntityChunks método para inserir uma única HTTP_DATA_CHUNK estrutura ou uma matriz de HTTP_DATA_CHUNK estruturas no corpo da resposta. Se a operação tiver sido concluída de forma síncrona, o pcbSent parâmetro receberá o número de bytes que foram inseridos na resposta.

Se o buffer estiver ativado, o WriteEntityChunks método criará uma cópia de qualquer HTTP_DATA_CHUNK estrutura, duplicando assim os dados subjacentes para que eles não precisem ser preservados. Se o buffer estiver desativado ou o limite do buffer de resposta for atingido, o WriteEntityChunks método também liberará a resposta. Se o buffer estiver desativado e o fAsync parâmetro for true, a memória deverá ser preservada até que a solicitação seja concluída.

Você pode configurar uma WriteEntityChunks operação para ser concluída de forma assíncrona definindo o fAsync parâmetro como true. Nessa situação, o WriteEntityChunks método retornará imediatamente ao chamador e o pcbSent parâmetro não receberá o número de bytes inseridos na resposta. Se o buffer estiver desabilitado e o fAsync parâmetro for true, a memória do pDataChunks parâmetro deverá ser mantida até que a chamada assíncrona seja concluída.

Um máximo de 65535 partes (64 KB menos 1) pode ser gravado em uma solicitação.

Exemplo

O exemplo a seguir demonstra como usar o WriteEntityChunks método para criar um módulo HTTP que insere uma matriz de duas partes de dados na resposta. Em seguida, o exemplo retorna a resposta a 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
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create an array of data chunks.
        HTTP_DATA_CHUNK dataChunk[2];

        // Buffer for bytes written of data chunk.
        DWORD cbSent;
        
        // Create string buffers.
        PCSTR pszOne = "First chunk data\n";
        PCSTR pszTwo = "Second chunk data\n";

        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Clear the existing response.
            pHttpResponse->Clear();
            // Set the MIME type to plain text.
            pHttpResponse->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);
            
            // Set the chunk to a chunk in memory.
            dataChunk[0].DataChunkType = HttpDataChunkFromMemory;
            // Set the chunk to the first buffer.
            dataChunk[0].FromMemory.pBuffer =
                (PVOID) pszOne;
            // Set the chunk size to the first buffer size.
            dataChunk[0].FromMemory.BufferLength =
                (USHORT) strlen(pszOne);

            // Set the chunk to a chunk in memory.
            dataChunk[1].DataChunkType = HttpDataChunkFromMemory;
            // Set the chunk to the second buffer.
            dataChunk[1].FromMemory.pBuffer =
                (PVOID) pszTwo;
            // Set the chunk size to the second buffer size.
            dataChunk[1].FromMemory.BufferLength =
                (USHORT) strlen(pszTwo);

            // Insert the data chunks into the response.
            hr = pHttpResponse->WriteEntityChunks(
                dataChunk,2,FALSE,TRUE,&cbSent);

            // 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;
        }            
    }

    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

IHttpResponse Interface
Método IHttpResponse::WriteEntityChunkByReference