Skip to content

Latest commit

 

History

History
83 lines (68 loc) · 9.97 KB

ihttpeventprovider-interface.md

File metadata and controls

83 lines (68 loc) · 9.97 KB
title description ms.date ms.assetid
IHttpEventProvider Interface
IHttpEventProvider Interface provides a generic event-reporting interface.
10/07/2016
1f7b9790-66d0-fd22-edf0-721693702d35

IHttpEventProvider Interface

Provides a generic event-reporting interface.

Syntax

class IHttpEventProvider  

Methods

The following table lists the methods exposed by the IHttpEventProvider class.

Name Description
SetErrorStatus Specifies an error to return.

Derived Classes

The following table lists the derived classes exposed by the IHttpEventProvider interface.

Name Description
IAuthenticationProvider Provides an interface for RQ_REQUEST_AUTHENTICATE event notifications.
ICacheProvider Provides an interface for GL_CACHE_OPERATION event notifications.
ICustomNotificationProvider Provides an interface for GL_CUSTOM_NOTIFCATION and RQ_CUSTOM_NOTIFCATION event notifications.
IGlobalConfigurationChangeProvider Provides an interface for GL_CONFIGURATION_CHANGE event notifications.
IGlobalFileChangeProvider Provides an interface for GL_FILE_CHANGE event notifications.
IGlobalRSCAQueryProvider Provides an interface for GL_RSCA_QUERY event notifications.
IGlobalStopListeningProvider Provides an interface for GL_STOP_LISTENING event notifications.
IGlobalThreadCleanupProvider Provides an interface for GL_THREAD_CLEANUP event notifications.
IGlobalTraceEventProvider Provides an interface for GL_TRACE_EVENT event notifications.
IHttpApplicationProvider Provides an interface for GL_APPLICATION_START event notifications.
IMapHandlerProvider Provides an interface for RQ_DETERMINE_HANDLER event notifications.
IMapPathProvider Provides an interface for RQ_MAP_PATH event notifications.
IPreBeginRequestProvider Provides an interface for GL_PRE_BEGIN_REQUEST event notifications.
IReadEntityProvider Provides an interface for RQ_READ_ENTITY event notifications.
ISendResponseProvider Provides an interface for RQ_SEND_RESPONSE event notifications.

Remarks

The IHttpEventProvider interface provides the generic event-reporting interface for most notification methods, and it serves as the parent class for the event-reporting interfaces that are used with the remaining notifications.

The IHttpEventProvider interface exposes only the SetErrorStatus method, which sets the error status for the current context. Several of the derived classes that are inherited from IHttpEventProvider expose additional methods that are specific to their respective events.

Example

The following code example demonstrates how to create an HTTP module that sends an example string to the Web client and captures the return value from this operation. The module uses the SetErrorStatus method to specify the return value as the error status for the current request and then exits.

[!code-cppIHttpEventProviderSetErrorStatus#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

Web Server Core Interfaces
IAuthenticationProvider Interface
ICacheProvider Interface
ICustomNotificationProvider Interface
IGlobalConfigurationChangeProvider Interface
IGlobalFileChangeProvider Interface
IGlobalRSCAQueryProvider Interface
IGlobalStopListeningProvider Interface
IGlobalThreadCleanupProvider Interface
IGlobalTraceEventProvider Interface
IHttpApplicationProvider Interface
IMapHandlerProvider Interface
IMapPathProvider Interface
IPreBeginRequestProvider Interface
IReadEntityProvider Interface
ISendResponseProvider Interface