Skip to content

ihttprequest-getforwardedurl-method.md

Latest commit

 

History

History
53 lines (35 loc) · 3.32 KB

ihttprequest-getforwardedurl-method.md

File metadata and controls

53 lines (35 loc) · 3.32 KB
title IHttpRequest::GetForwardedUrl Method
description Learn how the IHttpRequest::GetForwardedUrl method returns the forwarded URL, as well as details about its parameters, return value, and requirements.
ms.date 10/07/2016
ms.assetid 610c7fcd-5354-9021-d7a7-f8543c916143

IHttpRequest::GetForwardedUrl Method

Returns the forwarded URL.

Syntax

virtual PCWSTR GetForwardedUrl(  
   VOID  
) const = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to a string that contains the forwarded URL.

Remarks

The GetForwardedUrl method retrieves the URL after a call to the IHttpRequest::SetUrl method, but only when the URL does not refer to a local address. If you use SetUrl to specify a local URL, the GetForwardedUrl method will return NULL.

Example

The following code example demonstrates how to create an HTTP module that calls the IHttpRequest::SetUrl method to set the URL for the request to http://www.microsoft.com. The module then calls the GetForwardedUrl method to retrieve the forwarded URL. The module tests whether the forwarded URL is NULL. If the forwarded URL is not NULL, the module displays the URL to a Web client.

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