Skip to content

cglobalmodule-onglobaltraceevent-method.md

Latest commit

 

History

History
50 lines (37 loc) · 3.69 KB

cglobalmodule-onglobaltraceevent-method.md

File metadata and controls

50 lines (37 loc) · 3.69 KB
title CGlobalModule::OnGlobalTraceEvent Method
description Describes the CGlobalModule::OnGlobalTraceEvent method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid 0c551af0-1f2a-ed9f-2d2b-896771e0bb92

CGlobalModule::OnGlobalTraceEvent Method

Represents the method that will handle a GlobalTraceEvent event, which occurs when a trace event is raised.

Syntax

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalTraceEvent(  
   IN IGlobalTraceEventProvider* pProvider  
);

Parameters

pProvider
[IN] A pointer to an IGlobalTraceEventProvider interface.

Return Value

A GLOBAL_NOTIFICATION_STATUS value.

Remarks

When a global module has registered for the GL_TRACE_EVENT event notification, IIS will call the module's OnGlobalTraceEvent method when a trace event occurs.

Note

Global modules can register for the GlobalTraceEvent event notification by registering for GL_TRACE_EVENT 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_TRACE_EVENT notification. If a tracing-related event occurs, IIS will call the example module's OnGlobalTraceEvent method. This method will write an entry in the application log of the Windows Event Viewer and then exit.

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