Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 3.75 KB

ihttpcontext-getscriptmap-method.md

File metadata and controls

52 lines (39 loc) · 3.75 KB
title description ms.date ms.assetid
IHttpContext::GetScriptMap Method
Describes the IHttpContext::GetScriptMap method and details its syntax, parameters, return value, remarks, code example, and requirements.
10/07/2016
40fada80-5a67-0c1c-d9cd-0bfedf8ffcd1

IHttpContext::GetScriptMap Method

Returns the script map container for the current context.

Syntax

virtual IScriptMapInfo* GetScriptMap(  
   VOID  
) const = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to an IScriptMapInfo interface.

Remarks

The GetScriptMap method is used to retrieve a pointer to the IScriptMapInfo interface for the current context. The IScriptMapInfo interface contains several methods that return information about the scripting environment.

Note

The HTTP context object owns the lifetime of this object. Therefore, you do not free this pointer when writing HTTP modules.

Example

The following code example demonstrates how to use the GetScriptMap method to create an HTTP module that retrieves a pointer to an IScriptMapInfo interface. The example then uses the IScriptMapInfo::GetAllowedVerbs method to retrieve the list of HTTP methods that are allowed for the current request path.

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

IHttpContext Interface
IScriptMapInfo Interface
IHttpContext::GetScriptName Method
IHttpContext::GetScriptTranslated Method