Skip to content

ihttpcontext-getscripttranslated-method.md

Latest commit

 

History

History
53 lines (40 loc) · 3.49 KB

ihttpcontext-getscripttranslated-method.md

File metadata and controls

53 lines (40 loc) · 3.49 KB
title IHttpContext::GetScriptTranslated Method
description The IHttpContext::GetScriptTranslated method retrieves the physical path of the current request. This article describes its syntax, return value, remarks, example, and requirements.
ms.date 10/07/2016
ms.assetid 80a1063c-b33b-7af1-b445-1a49922cd728

IHttpContext::GetScriptTranslated Method

Retrieves the physical path of the current request.

Syntax

virtual PCWSTR GetScriptTranslated(  
   DWORD* pcchScriptName = NULL  
) = 0;

Parameters

pcchScriptName
A pointer to a DWORD that receives the length of the returned string.

Return Value

A pointer to a string that contains the translated path for the current script.

Remarks

The GetScriptTranslated method is used to retrieve a pointer to a buffer that contains the physical path of the current URL.

Note

The server owns the lifetime of this pointer.

Example

The following code example demonstrates how to use the GetScriptTranslated method to create an HTTP module that retrieves the physical path of the current script. The example returns that information to a Web client and then exits.

[!code-cppIHttpContextGetScriptTranslated#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
IHttpContext::GetScriptMap Method
IHttpContext::GetScriptName Method
IHttpContext::MapPath Method