Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 3.51 KB

ihttprequest-getremainingentitybytes-method.md

File metadata and controls

48 lines (36 loc) · 3.51 KB
title description ms.date ms.assetid
IHttpRequest::GetRemainingEntityBytes Method
Describes the IHttpRequest::GetRemainingEntityBytes method and details its syntax, parameters, return value, code examples, and requirements.
10/07/2016
290bdb6a-d69c-775f-b436-6c703a826d2b

IHttpRequest::GetRemainingEntityBytes Method

Returns the number of remaining bytes to be read from the client.

Syntax

virtual DWORD GetRemainingEntityBytes(  
   VOID  
) = 0;  

Parameters

This method takes no parameters.

Return Value

A DWORD that contains the number of bytes of data that remain to be read.

Remarks

The GetRemainingEntityBytes method determines the size of the remaining data bytes in the current request. For example, if you created a module that used the IHttpRequest::ReadEntityBody method to retrieve a partial segment of the current request, you would use the GetRemainingEntityBytes method to determine the amount of data that is left in the request for processing.

Example

The following code example demonstrates how to use the GetRemainingEntityBytes method to create an HTTP module that retrieves the number of bytes to be read from the client.

[!code-cppIHttpRequestGetRemainingEntityBytes#1]

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Httpserv.h

See Also

IHttpRequest Interface
IHttpRequest::ReadEntityBody Method
IHttpRequest::InsertEntityBody Method