IHttpContext::MapPath Method

IIS 7.0
 

Returns the physical path of a relative URL.

virtual HRESULT MapPath(
   PCWSTR pszUrl,
   __out_bcount(* pcbPhysicalPath) PWSTR pszPhysicalPath,
   DWORD* pcbPhysicalPath
) = 0;

pszUrl

[IN] A pointer to a string that contains the relative URL to map.

pszPhysicalPath

[OUT] A pointer to a string that receives the mapped path.

pcbPhysicalPath

[IN] A pointer to a DWORD that contains the size of the buffer pointed to by pszPhysicalPath.

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value

Description

S_OK

Indicates that the operation was successful.

ERROR_INSUFFICIENT_BUFFER

Indicates that the buffer pointed to by pszPhysicalPath is not large enough to perform the operation.

ERROR_NOT_ENOUGH_MEMORY

Indicates that there is insufficient memory to perform the operation.

The MapPath method returns the physical location of the relative URL that is contained in the pszUrl parameter.

System_CAPS_noteNote

If the buffer pointed to by the pszPhysicalPath parameter is not large enough to perform the operation, the pcbPhysicalPath DWORD parameter will contain the required buffer size for the operation.

Example

The following code example demonstrates how to use the MapPath method to create an HTTP module that returns the physical path of the root folder for the Web site that uses this module.

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 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: