HttpResponse.WriteFile Method (String, Int64, Int64)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Writes the specified file directly to an HTTP response output stream.

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

Public Sub WriteFile (
	filename As String,
	offset As Long,
	size As Long
)

Parameters

filename
Type: System.String

The name of the file to write to the HTTP output stream.

offset
Type: System.Int64

The byte position in the file where writing will start.

size
Type: System.Int64

The number of bytes to write to the output stream.

Exception Condition
HttpException

offset is less than 0.

- or -

size is greater than the file size minus offset.

ArgumentNullException

The filename parameter is null.

When this method is used with large files, calling the method might throw an exception. The size of the file that can be used with this method depends on the hardware configuration of the Web server. For more information, see article 812406, "PRB: Response.WriteFile Cannot Download a Large File" on the Microsoft Knowledge Base Web site.

The following example writes all the contents of a text file named Login.txt (which might contain literal text and HTML input controls) directly to the output stream.

Dim FileName As String
 Dim MyFileInfo As FileInfo
 Dim StartPos, FileSize As Long

 FileName = "c:\\temp\\login.txt"
 MyFileInfo = New FileInfo(FileName)
 FileSize = MyFileInfo.Length 

 Response.Write("Please Login: <br>")
 Response.WriteFile(FileName, StartPos, FileSize)

.NET Framework
Available since 1.1
Return to top
Show: