Uri.MakeRelative(Uri) Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

Uri.cs

Caution

Uri.MakeRelative has been deprecated. Use MakeRelativeUri(Uri uri) instead.

Determines the difference between two Uri instances.

public:
 System::String ^ MakeRelative(Uri ^ toUri);

[System.Obsolete("Uri.MakeRelative has been deprecated. Use MakeRelativeUri(Uri uri) instead.")]
public string MakeRelative (Uri toUri);

[<System.Obsolete("Uri.MakeRelative has been deprecated. Use MakeRelativeUri(Uri uri) instead.")>]
member this.MakeRelative : Uri -> string

Public Function MakeRelative (toUri As Uri) As String

Parameters

toUri

Uri

The URI to compare to the current URI.

Returns

String

If the hostname and scheme of this URI instance and toUri are the same, then this method returns a String that represents a relative URI that, when appended to the current URI instance, yields the toUri parameter.

If the hostname or scheme is different, then this method returns a String that represents the toUri parameter.

Attributes

ObsoleteAttribute

Exceptions

ArgumentNullException

toUri is null.

InvalidOperationException

This instance represents a relative URI, and this method is valid only for absolute URIs.

Examples

The following example creates 2 Uri instances. The difference in the path information is written to the console.

// Create a base Uri.
Uri^ address1 = gcnew Uri( "http://www.contoso.com/" );

// Create a new Uri from a string.
Uri^ address2 = gcnew Uri( "http://www.contoso.com/index.htm?date=today" );

// Determine the relative Uri.  
Console::WriteLine( "The difference is {0}", address1->MakeRelativeUri( address2 ) );

// Create a base Uri.
Uri address1 = new Uri("http://www.contoso.com/");

// Create a new Uri from a string.
Uri address2 = new Uri("http://www.contoso.com/index.htm?date=today");

// Determine the relative Uri.
Console.WriteLine("The difference is {0}", address1.MakeRelativeUri(address2));

// Create a base Uri.
let address1 = Uri "http://www.contoso.com/"

// Create a new Uri from a string.
let address2 = Uri "http://www.contoso.com/index.htm?date=today"

// Determine the relative Uri.
printfn $"The difference is {address1.MakeRelativeUri address2}"

    ' Create a base Uri.
    Dim address1 As New Uri("http://www.contoso.com/")
    
    ' Create a new Uri from a string.
    Dim address2 As New Uri("http://www.contoso.com/index.htm?date=today")
    
    ' Determine the relative Uri.  
    Console.WriteLine("The difference is {0}", address1.MakeRelativeUri(address2))

End Sub

Remarks

The following table shows the URI instance, toUri, and the results of calling MakeRelative.

Current URI instance	toUri	Return value
http://www.contoso.com/	http://www.contoso.com/test/test.htm	test/test.htm
http://www.contoso.com/test1/	http://www.contoso.com/	../
http://www.contoso.com:8000/	http://www.contoso.com/test/test.htm	http://www.contoso.com/test/test.htm
http://username@www.contoso.com/	http://www.contoso.com/test1/test1.txt	test1/test1.txt

User information, if present in the URI, is ignored.