Skip to content

cglobalmodule-onglobalrscaquery-method.md

Latest commit

 

History

History
50 lines (37 loc) · 3.74 KB

cglobalmodule-onglobalrscaquery-method.md

File metadata and controls

50 lines (37 loc) · 3.74 KB
title CGlobalModule::OnGlobalRSCAQuery Method
description Learn how the OnGlobalRSCAQuery method represents the method handles a GlobalRSCAQuery event, which occurs when a Run-Time Status and Control query is executed.
ms.date 10/07/2016
ms.assetid 6487da24-9a75-3a63-a9af-5f3842d7a5ff

CGlobalModule::OnGlobalRSCAQuery Method

Represents the method that will handle a GlobalRSCAQuery event, which occurs when a Run-Time Status and Control query is executed.

Syntax

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalRSCAQuery(  
   IN IGlobalRSCAQueryProvider* pProvider  
);

Parameters

pProvider
[IN] A pointer to an IGlobalRscaQueryProvider interface.

Return Value

A GLOBAL_NOTIFICATION_STATUS value.

Remarks

When a global module has registered for the GL_RSCA_QUERY event notification, IIS will call the module's OnGlobalRSCAQuery method when a Run-Time Status and Control query occurs.

Note

Global modules can register for the GlobalRSCAQuery event notification by registering for GL_RSCA_QUERY 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_RSCA_QUERY notification. If a Run-Time Status and Control query occurs, IIS will call the example module's OnGlobalRSCAQuery method. This method will write an entry in the application log of the Windows Event Viewer and then exit.

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