Uri.MakeRelativeUri Method (System)

MakeRelativeUri Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Uri..::.MakeRelativeUri Method

Determines the difference between two Uri instances.

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

Syntax

Visual Basic (Declaration)

Public Function MakeRelativeUri ( _
    uri As Uri _
) As Uri

Visual Basic (Usage)

Dim instance As Uri
Dim uri As Uri
Dim returnValue As Uri

returnValue = instance.MakeRelativeUri(uri)

public Uri MakeRelativeUri(
    Uri uri
)

Visual C++

public:
Uri^ MakeRelativeUri(
    Uri^ uri
)

JScript

public function MakeRelativeUri(
    uri : Uri
) : Uri

Parameters

uri: Type: System..::.Uri
The URI to compare to the current URI.

Return Value

Type: System..::.Uri
If the hostname and scheme of this URI instance and toUri are the same, then this method returns a relative Uri that, when appended to the current URI instance, yields toUri.
If the hostname or scheme is different, then this method returns a Uri that represents the toUri parameter.

Exceptions

Exception	Condition
InvalidOperationException	This instance represents a relative URI, and this property is valid only for absolute URIs.

Remarks

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

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.

Examples

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

Visual Basic

    ' 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 'SampleMakeRelative

// 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));

Visual C++

// 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 ) );

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

Uri Class

Uri Members

System Namespace