.NET Framework Class Library
Uri..::.LocalPath Property

Gets a local operating-system representation of a file name.

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

Visual Basic (Declaration)
Public ReadOnly Property LocalPath As String
Visual Basic (Usage)
Dim instance As Uri
Dim value As String

value = instance.LocalPath
C#
public string LocalPath { get; }
Visual C++
public:
property String^ LocalPath {
    String^ get ();
}
JScript
public function get LocalPath () : String

Property Value

Type: System..::.String
A String that contains the local operating-system representation of a file name.
Exceptions

ExceptionCondition
InvalidOperationException

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

Remarks

The value returned by this property is unescaped. If the path is recognized as a Windows file path, all forward slashes (/) are replaced by backward slashes (\).

For the URI file://computer/file.ext, the absolute path is /file.ext and the local path is \\computer\file.ext.

Examples

The following example creates a Uri instance and writes the local path to the console.

Visual Basic
    Dim uriAddress2 As New Uri("file://server/filename.ext")
    Console.WriteLine(uriAddress2.LocalPath)
    Console.WriteLine("Uri {0} a UNC path", IIf(uriAddress2.IsUnc, "is", "is not")) 'TODO: For performance reasons this should be changed to nested IF statements
    Console.WriteLine("Uri {0} a local host", IIf(uriAddress2.IsLoopback, "is", "is not")) 'TODO: For performance reasons this should be changed to nested IF statements
    Console.WriteLine("Uri {0} a file", IIf(uriAddress2.IsFile, "is", "is not")) 'TODO: For performance reasons this should be changed to nested IF statements

End Sub 'GetParts
C#
Uri uriAddress2 =  new Uri("file://server/filename.ext");
Console.WriteLine(uriAddress2.LocalPath);
Console.WriteLine("Uri {0} a UNC path", uriAddress2.IsUnc ? "is" : "is not");
Console.WriteLine("Uri {0} a local host", uriAddress2.IsLoopback ? "is" : "is not");
Console.WriteLine("Uri {0} a file", uriAddress2.IsFile ? "is" : "is not");
Visual C++
Uri^ uriAddress2 = gcnew Uri( "file://server/filename.ext" );
Console::WriteLine( uriAddress2->LocalPath );
Console::WriteLine( "Uri {0} a UNC path", uriAddress2->IsUnc ? (String^)"is" : "is not" );
Console::WriteLine( "Uri {0} a local host", uriAddress2->IsLoopback ? (String^)"is" : "is not" );
Console::WriteLine( "Uri {0} a file", uriAddress2->IsFile ? (String^)"is" : "is not" );
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, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

Tags :


Community Content

Stanley Roark
How to get a valid filename from an uri

When you have an uri location for a file like here:

string fileLocation = @"file://localhost/F:/Musica/_Selezioni/Bj%C3%B6rk%2FDebut%2F01.Human%20Behaviour.mp3";


you can extract a valid filename (one that you can use with System.IO.File and System.IO.FileInfo) with GetComponents() method:

Uri fileUri = new Uri(fileLocation);
string filename = fileUri.GetComponents(UriComponents.Path, UriFormat.SafeUnescaped);



Tags : uri

adam.sida
URI.LocalPath problem

when calling following code:

string filePath = System.Reflection.Assembly.GetExecutingAssembly().GetName().CodeBase;
Uri u = new Uri(filePath);
string filename = u.GetComponents(UriComponents.Path, UriFormat.SafeUnescaped);
string path = u.LocalPath;

the uri object returns only fragment of whole path to file, by splitting path somewhere in the middle ;-(
tested on .NET 2.0, .NET3.5

Page view tracker