Share via


IReadEntityProvider Interface

 

Provides an interface for retrieving or modifying the request entity.

Syntax

class IReadEntityProvider : public IHttpEventProvider  

Methods

The following table lists the methods exposed by the IReadEntityProvider interface.

Name Description
GetEntity Retrieves the request entity.
SetEntity Specifies the request entity.
SetErrorStatus (Inherited from IHttpEventProvider.)

Derived Classes

This interface contains no derived classes.

Remarks

IIS creates and passes an IReadEntityProvider interface to a module's CHttpModule::OnReadEntity method when the module has registered for the RQ_READ_ENTITY notification in the module's exported RegisterModule function.

Note IIS will trigger CHttpModule::OnReadEntity() event for every IHttpRequest::ReadEntityBody Method even if there is no entity left to read. This behavior addresses scenarios where a module should insert some entity when there is no request entity. You must write some entity-length-verification code so that your CHttpModule::OnReadEntity() handler is aware of the possibility of a zero entity length.

Inheritance Hierarchy

IHttpEventProvider

IReadEntityProvider

Requirements

Type Description
Client - IIS 7.0 on Windows Vista
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on Windows Server 2008
- 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 Technical Preview
Product - 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
Header Httpserv.h

See Also

Web Server Core Interfaces