Skip to content

iscriptmapinfo-getpath-method.md

Latest commit

 

History

History
51 lines (37 loc) · 3.77 KB

iscriptmapinfo-getpath-method.md

File metadata and controls

51 lines (37 loc) · 3.77 KB
title IScriptMapInfo::GetPath Method
description IScriptMapInfo::GetPath Method retrieves the path attribute for a request handler.
ms.date 10/07/2016
ms.assetid 94934509-f6be-8dd3-3d06-a5505a126c56

IScriptMapInfo::GetPath Method

Retrieves the path attribute for a request handler.

Syntax

virtual PCWSTR GetPath(  
   VOID  
) const = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to a string that contains the request handler's path attribute.

Remarks

The GetPath method retrieves the path attribute for a request handler that is located in the <handlers> section of the ApplicationHost.config file. This attribute contains the path definition that the request handler will process.

For example, if a Web client requests a classic ASP page, the GetPath method will return "*.ASP" by default.

Note

Do not confuse GetPath with the IScriptMapInfo::GetName or IScriptMapInfo::GetScriptProcessor methods, which return the name and scriptProcessor attributes, respectively, for the request handler.

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 GetPath method to retrieve the path attribute for the request handler that is processing the current request. The module returns the path attribute to a Web client and then exits.

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