Path.GetRelativePath(String, String) Method

Reference

Definition

Namespace:: System.IO

Assembly:: System.Runtime.dll

Assembly:: System.Runtime.Extensions.dll

Assembly:: netstandard.dll

Source:: Path.cs

Source:: Path.cs

Source:: Path.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a relative path from one path to another.

public:
 static System::String ^ GetRelativePath(System::String ^ relativeTo, System::String ^ path);

public static string GetRelativePath (string relativeTo, string path);

static member GetRelativePath : string * string -> string

Public Shared Function GetRelativePath (relativeTo As String, path As String) As String

Parameters

relativeTo: String

The source path the result should be relative to. This path is always considered to be a directory.

path: String

The destination path.

Returns

String

The relative path, or path if the paths don't share the same root.

Exceptions

ArgumentNullException

relativeTo or path is null.

ArgumentException

relativeTo or path is effectively empty.

Examples

The following code shows how to call the GetRelativePath method.

// "C:/Program Files/Microsoft" relative to "C:/Program Files/Common Files" is "../Microsoft"
Console.WriteLine(Path.GetRelativePath("C:/Program Files/Common Files", "C:/Program Files/Microsoft"));
// "C:/Program Files/Microsoft" relative to "C:/Program Files/" is "Microsoft"
Console.WriteLine(Path.GetRelativePath("C:/Program Files/", "C:/Program Files/Microsoft"));

// This code produces output similar to the following:
//
// ../Microsoft
// Microsoft

' "C:/Program Files/Microsoft" relative to "C:/Program Files/Common Files" is "../Microsoft"
Console.WriteLine(Path.GetRelativePath("C:/Program Files/Common Files", "C:/Program Files/Microsoft"))
' "C:/Program Files/Microsoft" relative to "C:/Program Files/" is "Microsoft"
Console.WriteLine(Path.GetRelativePath("C:/Program Files/", "C:/Program Files/Microsoft"))

' This code produces output similar to the following:
'
' ../Microsoft
' Microsoft

Remarks

Paths are resolved by calling the GetFullPath method before calculating the difference. The method uses the default file path comparison for the current platform (StringComparison.OrdinalIgnoreCase for Windows and MacOs, StringComparison.Ordinal for Linux.

Applies to