IScriptMapInfo::GetScriptProcessor Method

IScriptMapInfo::GetScriptProcessor Method

IIS 7.0
 

Retrieves the script processor for a request handler.

virtual PCWSTR GetScriptProcessor(
   DWORD* pcchScriptProcessor = NULL
) const = 0;

pcchScriptProcessor

A pointer to a DWORD buffer that receives the length, in characters, of the request handler.

A pointer to a string that contains the path of the script-processing engine.

The GetScriptProcessor method retrieves the scriptProcessor attribute for a request handler that is located in the <handlers> section of the ApplicationHost.config file. This attribute contains the full path to the script processor for the request handler, or nothing if the requested resource was not a script.

For example, if a Web client requests a file with a .txt extension, GetScriptProcessor returns nothing by default, because text files are not configured with a script processor. By contrast, if a Web client requests a file with an .asp extension, GetScriptProcessor returns the full path to the Asp.dll script engine.

System_CAPS_noteNote

Do not confuse GetScriptProcessor with the IScriptMapInfo::GetPath or IScriptMapInfo::GetName methods, which return the path and name 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 GetScriptProcessor method to retrieve the full path of the script engine for the request handler that is processing the current request. The module returns the path to a Web client and then exits.

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 Windows Vista

  • IIS 7.5 on Windows 7

  • IIS 8.0 on Windows 8

  • IIS 10.0 on Windows 10

Server

  • IIS 7.0 on Windows Server 2008

  • 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 Technical Preview

Product

  • IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0

  • IIS Express 7.5, IIS Express 8.0, IIS Express 10.0

Header

Httpserv.h

Show:
© 2016 Microsoft