Método IHttpRequest::InsertEntityBody
Insere um novo corpo de entidade no corpo da solicitação HTTP existente.
Sintaxe
virtual HRESULT InsertEntityBody(
IN VOID* pvBuffer,
IN DWORD cbBuffer
) = 0;
Parâmetros
pvBuffer
[IN] Um ponteiro para um VOID
buffer que contém o corpo da entidade de solicitação.
cbBuffer
[IN] Um DWORD
que contém o tamanho, em bytes, do buffer.
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. |
Comentários
O método InsertEntityBody insere o corpo da entidade apontado pelo pvBuffer
parâmetro no corpo da entidade de solicitação HTTP.
Observação
O ponto de inserção do novo corpo da entidade é antes de qualquer corpo de entidade não lido restante que possa ser recuperado posteriormente do cliente Web.
Importante
O IIS não faz uma cópia do buffer do corpo da entidade. O buffer de entidade do módulo deve ser preservado até o final da solicitação.
Esse método não atualiza o valor do cabeçalho Content-Length. Um módulo que usa esse método deve atualizar o Content-Length separadamente.
Exemplo
O exemplo de código a seguir demonstra como criar um módulo HTTP que chama o método IHttpContext::AllocateRequestMemory para alocar um buffer de 1 KB. Em seguida, o módulo copia a cadeia de caracteres "Olá, Mundo" no buffer. Por fim, o módulo chama o InsertEntityBody
método para substituir o corpo da entidade de solicitação HTTP pré-carregada pelo buffer e, em seguida, é encerrado.
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// NOTE - Data needs to be passed to this module, e.g. a POST request, or it will not appear to return anything.
// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
REQUEST_NOTIFICATION_STATUS
OnBeginRequest(
IN IHttpContext * pHttpContext,
IN IHttpEventProvider * pProvider
)
{
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Allocate a 1K buffer.
DWORD cbBuffer = 1024;
void * pvBuffer = pHttpContext->AllocateRequestMemory(cbBuffer);
// Test for an error.
if (NULL == pvBuffer)
{
// Set the error status.
pProvider->SetErrorStatus(
HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY));
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Copy a string into the buffer.
strcpy_s((char*)pvBuffer,cbBuffer,"Hello world!");
// Insert the entity body into the buffer.
hr = pHttpContext->GetRequest()->InsertEntityBody(
pvBuffer,(DWORD)strlen((char*)pvBuffer));
// 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
Tipo | 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 |