Skip to content

iscriptmapinfo-getmodules-method.md

Latest commit

 

History

History
49 lines (36 loc) · 3.66 KB

iscriptmapinfo-getmodules-method.md

File metadata and controls

49 lines (36 loc) · 3.66 KB
title IScriptMapInfo::GetModules Method
description Learn how the IScriptMapInfo::GetModules method retrieves the list of modules for a request handler.
ms.date 10/07/2016
ms.assetid b998fa9b-2ca5-9c15-c857-1fc0b0e2417d

IScriptMapInfo::GetModules Method

Retrieves the list of modules for a request handler.

Syntax

virtual PCWSTR GetModules(  
   DWORD* pcchModules = NULL  
) const = 0;

Parameters

pcchModules
A pointer to a DWORD buffer that receives the length, in characters, of the module list.

Return Value

A pointer to a string that contains a comma-delimited list of modules.

Remarks

The GetModules method retrieves the modules attribute for a request handler that is located in the <handlers> section of the ApplicationHost.config file. This attribute contains a comma-delimited list of modules for the request handler.

For example, if a Web client requests a classic ASP page, GetModules returns "IsapiModule" by default. If a client requests a static file, GetModules returns a comma-delimited list that contains "StaticFileModule", "DefaultDocumentModule", and "DirectoryListingModule" by default.

Example

The following code example demonstrates how to use the IHttpContext::GetScriptMap method to create an HTTP module that retrieves a pointer to an IScriptMapInfo interface. The example then uses the GetModules method to retrieve the list of modules for the request handler that is processing the current request. The module returns the module list to a Web client and then exits.

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

IScriptMapInfo Interface