Skip to content

cglobalmodule-onglobalprebeginrequest-method.md

Latest commit

 

History

History
50 lines (37 loc) · 3.82 KB

cglobalmodule-onglobalprebeginrequest-method.md

File metadata and controls

50 lines (37 loc) · 3.82 KB
title CGlobalModule::OnGlobalPreBeginRequest Method
description Describes the CGlobalModule::OnGlobalPreBeginRequest method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid 1c552a04-f229-33c5-af7f-05d28e55b9c9

CGlobalModule::OnGlobalPreBeginRequest Method

Represents the method that will handle a GlobalPreBeginRequest event, which occurs before a request enters the pipeline.

Syntax

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalPreBeginRequest(  
   IN IPreBeginRequestProvider* pProvider  
);

Parameters

pProvider
[IN] A pointer to an IPreBeginRequestProvider interface.

Return Value

A GLOBAL_NOTIFICATION_STATUS value.

Remarks

When a global module has registered for the GL_PRE_BEGIN_REQUEST event notification, IIS will call the module's OnGlobalPreBeginRequest method before a request enters the request pipeline.

Note

Global modules can register for the GlobalPreBeginRequest event notification by registering for GL_PRE_BEGIN_REQUEST in the module's RegisterModule function.

Example

The following code example demonstrates how to create a global-level HTTP module that registers for the GL_PRE_BEGIN_REQUEST notification. When a new request arrives, IIS will call the example module's OnGlobalPreBeginRequest method before the request enters the request pipeline. This method will write an entry in the application log of the Windows Event Viewer and then exit.

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

CGlobalModule Class