Skip to content

chttpmodule-onauthorizerequest-method.md

Latest commit

 

History

History
55 lines (41 loc) · 4.17 KB

chttpmodule-onauthorizerequest-method.md

File metadata and controls

55 lines (41 loc) · 4.17 KB
title CHttpModule::OnAuthorizeRequest Method
ms.date 10/07/2016
description CHttpModule OnAuthorizeRequest Method represents the method that will handle an AuthorizeRequest event, which occurs when IIS verifies user authorization.
ms.assetid b6d8bc63-87ae-1a7a-03e3-75ff30a0a039

CHttpModule::OnAuthorizeRequest Method

Represents the method that will handle an AuthorizeRequest event, which occurs when IIS verifies user authorization.

Syntax

virtual REQUEST_NOTIFICATION_STATUS OnAuthorizeRequest(  
   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_AUTHORIZE_REQUEST event notification, IIS will call the module's OnAuthorizeRequest method when IIS verifies the authorization for a user.

Note

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

Example

The following code example demonstrates how to create a request-level HTTP module that registers for the RQ_AUTHORIZE_REQUEST event and post-event notifications. When IIS verifies the authorization for a user, it will call the example module's OnAuthorizeRequest and OnPostAuthorizeRequest 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-cppCHttpModuleAuthorizeRequest#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::OnPostAuthorizeRequest Method