Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 4.58 KB

chttpmodule-onbeginrequest-method.md

File metadata and controls

60 lines (44 loc) · 4.58 KB
title ms.date description ms.assetid
CHttpModule::OnBeginRequest Method
10/07/2016
The CHttpModule OnBeginRequest Method represents the method that will handle a BeginRequest event.
eda1ad8f-124b-7d75-0acd-b4a4d9fbdd48

CHttpModule::OnBeginRequest Method

Represents the method that will handle a BeginRequest event, which occurs as the first event in the HTTP integrated request-processing pipeline for the current request.

Syntax

virtual REQUEST_NOTIFICATION_STATUS OnBeginRequest(  
   IN IHttpContext* pHttpContext,  
   IN IHttpEventProvider* pProvider  
);

Parameters

pHttpContext
[IN] A pointer to an IHttpContext interface.

pProvider
[IN] A pointer to an IHttpEventProvider interface.

Return Value

A REQUEST_NOTIFICATION_STATUS value.

Remarks

When a request-level module is registered for the RQ_BEGIN_REQUEST event notification, IIS will call the module's OnBeginRequest method when a request enters the integrated request-processing pipeline.

Note

Request-level modules can register for the BeginRequest event notification by registering for RQ_BEGIN_REQUEST in the module's RegisterModule function.

IIS calls a module's OnBeginRequest method before authentication and authorization; this allows developers to use the OnBeginRequest method to process requests where the client's identity is not an issue.

Note

Not all requests enter the integrated request-processing pipeline. A request for an image file that can be satisfied from the cache will not enter the integrated request-processing pipeline; therefore, the OnBeginRequest method will not be called.

Example

The following example demonstrates how to create a request-level HTTP module that registers for the RQ_BEGIN_REQUEST event and post-event notifications. When a request enters the pipeline, IIS will call the example module's OnBeginRequest and OnPostBeginRequest methods. Each method will write an entry in the application log of the Windows Event Viewer. When processing is complete, the module will exit.

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

CHttpModule Class
CHttpModule::OnPostBeginRequest Method