Skip to content

ihttpfileinfo-getfilepath-method.md

Latest commit

 

History

History
46 lines (34 loc) · 3.44 KB

ihttpfileinfo-getfilepath-method.md

File metadata and controls

46 lines (34 loc) · 3.44 KB
title IHttpFileInfo::GetFilePath Method
description Describes the IHttpFileInfo::GetFilePath method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid 3e353fe5-9c43-e137-b0e7-91c78d022f71

IHttpFileInfo::GetFilePath Method

Returns the physical path of the file referenced by an IHttpFileInfo interface.

Syntax

virtual PCWSTR GetFilePath(  
   VOID  
) const = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to a string that contains a physical path for a file.

Remarks

The GetFilePath method retrieves the physical path of a file that is currently referenced by the IHttpFileInfo interface. For example, if you write an HTTP module that calls the IHttpContext::GetFileInfo method to retrieve an IHttpFileInfo interface for the current request, the GetFilePath method will return the physical path of the file that was requested by a Web client.

Example

The following code example demonstrates how to use the IHttpContext::GetFileInfo method to create an HTTP module that retrieves a pointer to an IHttpFileInfo interface. The example then calls the GetFilePath method to retrieve the physical path of the file for the current request. Finally, the example displays this information to a Web client.

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

IHttpFileInfo Interface