Control.OpenFile(String) Method

Definition

Gets a Stream used to read a file.

protected public:
 System::IO::Stream ^ OpenFile(System::String ^ path);
protected internal System.IO.Stream OpenFile (string path);
member this.OpenFile : string -> System.IO.Stream
Protected Friend Function OpenFile (path As String) As Stream

Parameters

path
String

The path to the desired file.

Returns

A Stream that references the desired file.

Exceptions

Access to the specified file was denied.

Remarks

The OpenFile method returns a Stream object that can be used to read the contents of the file specified in the path parameter. The path parameter can be either a relative or root URL without a protocol (such as "~/mySite/myFile.txt), or a physical path, either local ("c:\mySite\myFile.txt") or UNC ("\\myServer\myFile.txt").

The OpenFile method uses file access security to control access to the specified file. If the current ASP.NET user does not have access to the file, then the file is not opened and an HttpException exception is thrown to indicate that access was denied. If the path parameter specified a relative path, the exception does not include information about the physical path to the requested file.

Applies to

See also