HttpContext.RewritePath Method (String, Boolean) (System.Web)

.NET Framework Class Library

HttpContext..::.RewritePath Method (String, Boolean)

Updated: July 2009

Rewrites the URL using the given path and a Boolean value that specifies whether the virtual path for server resources is modified.

Namespace: System.Web
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

Public Sub RewritePath ( _
    path As String, _
    rebaseClientPath As Boolean _
)

Visual Basic (Usage)

Dim instance As HttpContext
Dim path As String
Dim rebaseClientPath As Boolean

instance.RewritePath(path, rebaseClientPath)

public void RewritePath(
    string path,
    bool rebaseClientPath
)

Visual C++

public:
void RewritePath(
    String^ path, 
    bool rebaseClientPath
)

JScript

public function RewritePath(
    path : String, 
    rebaseClientPath : boolean
)

Parameters

path: Type: System..::.String
The internal rewrite path.

rebaseClientPath: Type: System..::.Boolean
true to reset the virtual path; false to keep the virtual path unchanged.

Exceptions

Exception	Condition
ArgumentNullException	The path parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
HttpException	The path parameter is not in the current application's root directory.

Remarks

The HttpContext..::.RewritePath(String, Boolean) method is called by the HttpContext..::.RewritePath(String) method with the rebaseClientPath parameter set to true. To ensure that the virtual path that is used to construct paths to resources is not modified, set the rebaseClientPath parameter to false. A common scenario in which you might want to set rebaseClientPath to false is when you need to rewrite the URL, and you are using themes and redirecting the URL to a resource located in a different folder than the requested resource.

URL rewriting is useful when you want to restructure the pages in your Web application, and you want to make sure that people who have bookmarked old URLs can still use them after you have moved pages. URL rewriting enables you to transparently forward requests to the new page location.

If you want to enable a site to use URLs that are more user-friendly and are optimized for search engines, a more robust alternative is to use ASP.NET routing. For more information, see ASP.NET Routing.

Examples

For a code example, see the RewritePath(String) method overload.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information