This documentation is archived and is not being maintained.

Control.MapPathSecure Method

Retrieves the physical path that a virtual path, either absolute or relative, maps to.

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

'Declaration
Protected Friend Function MapPathSecure ( _
	virtualPath As String _
) As String
'Usage
Dim virtualPath As String 
Dim returnValue As String 

returnValue = Me.MapPathSecure(virtualPath)

Parameters

virtualPath
Type: System.String

A relative or root relative URL.

Return Value

Type: System.String
The physical path to the requested file.

ExceptionCondition
ArgumentNullException

virtualPath is Nothing or an empty string ("").

This method can only be used by server controls that have permissions to read files and which are part of fully trusted .dll files, such as System.Web.dll. This helps prevent security breaches.

The following example uses the MapPathSecure method to obtain the physical path of a virtual directory of the containing Page or UserControl object.

' An HttpException occurs if the server control does not,; 
' have permissions to read the resulting mapped file.
output.Write("The Actual Path of the virtual directory : " & _
            MapPathSecure(TemplateSourceDirectory) & "<br>")

' Get all the files from the absolute path of 'MyControl'; 
' using TemplateSourceDirectory which gives the virtual Directory. 
Dim myFiles As String() = Directory.GetFiles(MapPathSecure(TemplateSourceDirectory))
output.Write("The files in this Directory are <br>")

' List all the files. 
Dim i As Integer 
For i = 0 To myFiles.Length - 1
   output.Write(myFiles(i) & "<br>")
Next i

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

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: