HTTP 요청 엔터티 본문을 반환합니다.
구문
virtual HRESULT ReadEntityBody(
OUT VOID* pvBuffer,
IN DWORD cbBuffer,
IN BOOL fAsync,
OUT DWORD* pcbBytesReceived,
OUT BOOL* pfCompletionPending = NULL
) = 0;
매개 변수
pvBuffer
[OUT] 요청 본문을 수신하는 버퍼에 대한 포인터입니다.
cbBuffer
[IN] 가 가리키는 pvBuffer버퍼의 크기(바이트)입니다.
fAsync
[IN] true 비동기적으로 작업을 완료하려면 이고, 그렇지 않으면 입니다 false.
pcbBytesReceived
[OUT] 메서드 호출이 동기적으로 완료되는 경우 실제로 읽은 바이트 수를 수신하는 버퍼에 대한 포인터 DWORD 입니다.
pfCompletionPending
[OUT] 비동기 완료가 보류 중인지 여부를 지정하는 값을 받는 부울 버퍼에 대한 포인터입니다.
반환 값
HRESULT입니다. 가능한 값에는 다음 표에 있는 값이 포함되지만, 이에 국한되는 것은 아닙니다.
| 값 | 설명 |
|---|---|
| S_OK | 작업이 성공했음을 나타냅니다. |
| ERROR_CONNECTION_INVALID | 현재 요청에 대한 바이트 수가 올바르지 않음을 나타냅니다. |
| ERROR_HANDLE_EOF | 읽을 남은 데이터가 없음을 나타냅니다. |
| ERROR_INVALID_PARAMETER | 매개 변수 중 하나에 잘못된 값이 전달되었음을 나타냅니다. |
| ERROR_NOT_ENOUGH_MEMORY | 작업을 수행할 메모리가 부족했음을 나타냅니다. |
설명
메서드는 ReadEntityBody 동기 및 비동기 호출을 모두 지원합니다.
참고
메서드를 ReadEntityBody 비동기적으로 호출하는 경우 모듈은 호출 직후를 반환해야 합니다.
메서드가 ReadEntityBody 호출 pvBuffer 되면 버퍼에 요청 본문이 포함되고 pcbBytesReceived , 메서드 호출이 동기적으로 완료된 경우 버퍼에 pvBuffer 반환된 요청 본문의 크기(바이트)가 버퍼에 포함됩니다.
또한 버퍼에는 pfCompletionPending 비동기 완료가 보류 중인지 여부를 지정하는 부울 값이 포함됩니다.
예제
다음 코드 예제에서는 메서드를 사용하여 ReadEntityBody 현재 요청에서 1KB 버퍼 섹션을 검색하는 HTTP 모듈을 만드는 방법을 보여 줍니다.
#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
)
{
UNREFERENCED_PARAMETER( pProvider );
// 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;
// Clear the existing response.
pHttpContext->GetResponse()->Clear();
// Set the MIME type to plain text.
pHttpContext->GetResponse()->SetHeader(
HttpHeaderContentType,"text/plain",
(USHORT)strlen("text/plain"),TRUE);
// Allocate a 1K buffer.
DWORD cbBytesReceived = 1024;
void * pvRequestBody = pHttpContext->AllocateRequestMemory(cbBytesReceived);
// Test for an error.
if (NULL == pvRequestBody)
{
// Set the error status.
hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
if (pHttpContext->GetRequest()->GetRemainingEntityBytes() > 0)
{
// Loop through the request entity.
while (pHttpContext->GetRequest()->GetRemainingEntityBytes() != 0)
{
// Retrieve the request body.
hr = pHttpContext->GetRequest()->ReadEntityBody(
pvRequestBody,cbBytesReceived,false,&cbBytesReceived,NULL);
// Test for an error.
if (FAILED(hr))
{
// End of data is okay.
if (ERROR_HANDLE_EOF != (hr & 0x0000FFFF))
{
// Set the error status.
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
}
dataChunk.FromMemory.pBuffer = pvRequestBody;
dataChunk.FromMemory.BufferLength = cbBytesReceived;
hr = pHttpContext->GetResponse()->WriteEntityChunks(
&dataChunk,1,FALSE,TRUE,NULL);
if (FAILED(hr))
{
// Set the error status.
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
}
// 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
);
}
모듈은 RegisterModule 함수를 내보내야 합니다. 프로젝트에 대한 모듈 정의(.def) 파일을 만들어 이 함수를 내보내거나 스위치를 사용하여 /EXPORT:RegisterModule 모듈을 컴파일할 수 있습니다. 자세한 내용은 연습: 네이티브 코드를 사용하여 Request-Level HTTP 모듈 만들기를 참조하세요.
필요에 따라 각 함수에 대한 호출 규칙을 명시적으로 선언하는 대신 호출 규칙을 사용하여 __stdcall (/Gz) 코드를 컴파일할 수 있습니다.
요구 사항
| 형식 | Description |
|---|---|
| 클라이언트 | - Windows Vista의 IIS 7.0 - Windows 7의 IIS 7.5 - Windows 8의 IIS 8.0 - WINDOWS 10 IIS 10.0 |
| 서버 | - Windows Server 2008의 IIS 7.0 - Windows Server 2008 R2의 IIS 7.5 - Windows Server 2012의 IIS 8.0 - Windows Server 2012 R2의 IIS 8.5 - WINDOWS SERVER 2016 IIS 10.0 |
| 제품 | - 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 |
| 헤더 | Httpserv.h |
참고 항목
IHttpRequest 인터페이스
IHttpRequest::GetRemainingEntityBytes 메서드
IHttpRequest::InsertEntityBody 메서드