VirtualPathUtility.MakeRelative Method (String, String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the relative virtual path from one virtual path containing the root operator (the tilde [~]) to another.

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

public static string MakeRelative(
	string fromPath,
	string toPath
)

Parameters

fromPath
Type: System.String

The starting virtual path to return the relative virtual path from.

toPath
Type: System.String

The ending virtual path to return the relative virtual path to.

Return Value

Type: System.String

The relative virtual path from fromPath to toPath.

Exception Condition
ArgumentException

fromPath is not rooted.

- or -

toPath is not rooted.

If the fromPath and toPath parameters are not rooted; that is, they do not equal the root operator (the tilde [~]), do not start with a tilde (~), such as a tilde and a slash mark (~/) or a tilde and a double backslash (~//), or do not start with a slash mark (/), an ArgumentException exception is thrown.

Query string parameters and HTML anchors that are used in the URI are not used in determining the relative path.

If fromPath is "/directory1/file1.aspx" and toPath is "/directory2/file2.aspx", the MakeRelative method returns "../directory2/file2.aspx".

.NET Framework
Available since 2.0
Return to top
Show: