Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 3.27 KB

ihttpcontext-getscriptname-method.md

File metadata and controls

52 lines (39 loc) · 3.27 KB
title description ms.date ms.assetid
IHttpContext::GetScriptName Method
Describes the IHttpContext::GetScriptName method and details its syntax, parameters, return value, remarks, code example, and requirements.
10/07/2016
be5e6a7d-b4b4-adf7-6d38-8619d053a0e0

IHttpContext::GetScriptName Method

Retrieves the URL for the current request.

Syntax

virtual PCWSTR GetScriptName(  
   DWORD* pcchScriptName = NULL  
) const = 0;  

Parameters

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

Return Value

A pointer to a string that contains the name of the current script.

Remarks

The GetScriptName method is used to retrieve a pointer to a buffer that contains the URL of the current request.

Note

The server owns the lifetime of this pointer.

Example

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

[!code-cppIHttpContextGetScriptName#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::GetScriptTranslated Method