ControllerBase.File Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Package:: Microsoft.AspNetCore.App.Ref v9.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v1.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v1.1.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Returns the file specified by `virtualPath` (Status200OK), the specified `contentType` as the Content-Type, and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Returns a file in the specified `fileStream` (Status200OK), the specified `contentType` as the Content-Type, and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Byte[], String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Returns a file with the specified `fileContents` as content (Status200OK), the specified `contentType` as the Content-Type, and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Returns the file specified by `virtualPath` (Status200OK), the specified `contentType` as the Content-Type, and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Returns the file specified by `virtualPath` (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Returns a file in the specified `fileStream` (Status200OK), the specified `contentType` as the Content-Type, and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Stream, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Returns a file in the specified `fileStream` (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Byte[], String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Returns a file with the specified `fileContents` as content (Status200OK), the specified `contentType` as the Content-Type, and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Byte[], String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Returns a file with the specified `fileContents` as content (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(String, String, String, Boolean)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Returns the file specified by `virtualPath` (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Stream, String, String, Boolean)	Returns a file in the specified `fileStream` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Stream, String)	Returns a file in the specified `fileStream` (Status200OK), with the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Byte[], String, String, Boolean)	Returns a file with the specified `fileContents` as content (Status200OK), the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Byte[], String)	Returns a file with the specified `fileContents` as content (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Stream, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Returns a file in the specified `fileStream` (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Byte[], String, Boolean)	Returns a file with the specified `fileContents` as content (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Byte[], String, String)	Returns a file with the specified `fileContents` as content (Status200OK), the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(String, String)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Stream, String, String)	Returns a file in the specified `fileStream` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(String, String, Boolean)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(String, String, String)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Byte[], String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Returns a file with the specified `fileContents` as content (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
File(Stream, String, Boolean)	Returns a file in the specified `fileStream` (Status200OK), with the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns the file specified by virtualPath (Status200OK), the specified contentType as the Content-Type, and the specified fileDownloadName as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType, System::String ^ fileDownloadName, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string? fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : string * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String, fileDownloadName As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue, enableRangeProcessing As Boolean) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns a file in the specified fileStream (Status200OK), the specified contentType as the Content-Type, and the specified fileDownloadName as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType, System::String ^ fileDownloadName, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string? fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : System.IO.Stream * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String, fileDownloadName As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue, enableRangeProcessing As Boolean) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

FileStreamResult

The created FileStreamResult for the response.

Attributes: NonActionAttribute

Remarks

The fileStream parameter is disposed after the response is sent.

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Byte[], String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns a file with the specified fileContents as content (Status200OK), the specified contentType as the Content-Type, and the specified fileDownloadName as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType, System::String ^ fileDownloadName, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string? fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : byte[] * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String, fileDownloadName As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue, enableRangeProcessing As Boolean) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

FileContentResult

The created FileContentResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType, System::String ^ fileDownloadName, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string? fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : string * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String, fileDownloadName As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns the file specified by virtualPath (Status200OK), and the specified contentType as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue, enableRangeProcessing As Boolean) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType, System::String ^ fileDownloadName, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string? fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : System.IO.Stream * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String, fileDownloadName As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

Returns

FileStreamResult

The created FileStreamResult for the response.

Attributes: NonActionAttribute

Remarks

The fileStream parameter is disposed after the response is sent.

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Stream, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns a file in the specified fileStream (Status200OK), and the specified contentType as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : System.IO.Stream * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue, enableRangeProcessing As Boolean) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

FileStreamResult

The created FileStreamResult for the response.

Attributes: NonActionAttribute

Remarks

The fileStream parameter is disposed after the response is sent.

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Byte[], String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType, System::String ^ fileDownloadName, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string? fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : byte[] * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String, fileDownloadName As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

Returns

FileContentResult

The created FileContentResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Byte[], String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns a file with the specified fileContents as content (Status200OK), and the specified contentType as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : byte[] * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue, enableRangeProcessing As Boolean) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

FileContentResult

The created FileContentResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(String, String, String, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns the file specified by virtualPath (Status200OK) with the specified contentType as the Content-Type and the specified fileDownloadName as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType, System::String ^ fileDownloadName, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string fileDownloadName, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string? fileDownloadName, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : string * string * string * bool -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string * string * bool -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String, fileDownloadName As String, enableRangeProcessing As Boolean) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Stream, String, String, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns a file in the specified fileStream (Status200OK) with the specified contentType as the Content-Type and the specified fileDownloadName as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType, System::String ^ fileDownloadName, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string fileDownloadName, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string? fileDownloadName, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : System.IO.Stream * string * string * bool -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string * string * bool -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String, fileDownloadName As String, enableRangeProcessing As Boolean) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

FileStreamResult

The created FileStreamResult for the response.

Attributes: NonActionAttribute

Remarks

The fileStream parameter is disposed after the response is sent.

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Stream, String)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns a file in the specified fileStream (Status200OK), with the specified contentType as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : System.IO.Stream * string -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

Returns

FileStreamResult

The created FileStreamResult for the response.

Attributes: NonActionAttribute

Remarks

The fileStream parameter is disposed after the response is sent.

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Byte[], String, String, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns a file with the specified fileContents as content (Status200OK), the specified contentType as the Content-Type and the specified fileDownloadName as the suggested file name. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType, System::String ^ fileDownloadName, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string fileDownloadName, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string? fileDownloadName, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : byte[] * string * string * bool -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string * string * bool -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String, fileDownloadName As String, enableRangeProcessing As Boolean) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

FileContentResult

The created FileContentResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Byte[], String)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : byte[] * string -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

Returns

FileContentResult

The created FileContentResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Stream, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : System.IO.Stream * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

Returns

FileStreamResult

The created FileStreamResult for the response.

Attributes: NonActionAttribute

Remarks

The fileStream parameter is disposed after the response is sent.

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Byte[], String, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : byte[] * string * bool -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string * bool -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String, enableRangeProcessing As Boolean) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

FileContentResult

The created FileContentResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Byte[], String, String)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType, System::String ^ fileDownloadName);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string fileDownloadName);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string? fileDownloadName);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : byte[] * string * string -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string * string -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String, fileDownloadName As String) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

Returns

FileContentResult

The created FileContentResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(String, String)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Returns the file specified by virtualPath (Status200OK) with the specified contentType as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : string * string -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Stream, String, String)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType, System::String ^ fileDownloadName);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string fileDownloadName);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string? fileDownloadName);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : System.IO.Stream * string * string -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string * string -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String, fileDownloadName As String) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

Returns

FileStreamResult

The created FileStreamResult for the response.

Attributes: NonActionAttribute

Remarks

The fileStream parameter is disposed after the response is sent.

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(String, String, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : string * string * bool -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string * bool -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String, enableRangeProcessing As Boolean) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(String, String, String)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType, System::String ^ fileDownloadName);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string fileDownloadName);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string? fileDownloadName);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : string * string * string -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string * string -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String, fileDownloadName As String) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Byte[], String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : byte[] * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

lastModified: Nullable<DateTimeOffset>

The DateTimeOffset of when the file was last modified.

entityTag: EntityTagHeaderValue

The EntityTagHeaderValue associated with the file.

Returns

FileContentResult

The created FileContentResult for the response.

Attributes: NonActionAttribute

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

File(Stream, String, Boolean)

Source:: ControllerBase.cs

Source:: ControllerBase.cs

Source:: ControllerBase.cs

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, bool enableRangeProcessing);

[<Microsoft.AspNetCore.Mvc.NonAction>]
abstract member File : System.IO.Stream * string * bool -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string * bool -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String, enableRangeProcessing As Boolean) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

FileStreamResult

The created FileStreamResult for the response.

Attributes: NonActionAttribute

Remarks

The fileStream parameter is disposed after the response is sent.

Applies to

ASP.NET Core 9.0 and other versions

Product	Versions
ASP.NET Core	2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

Share via

ControllerBase.File Method

Definition

Overloads

File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Parameters

Returns

Applies to

File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Parameters

Returns

Remarks

Applies to

File(Byte[], String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Parameters

Returns

Applies to

File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Parameters

Returns

Applies to

File(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Parameters

Returns

Applies to

File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Parameters

Returns

Remarks

Applies to

File(Stream, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Parameters

Returns

Remarks

Applies to

File(Byte[], String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Parameters

Returns

Applies to

File(Byte[], String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Parameters

Returns

Applies to

File(String, String, String, Boolean)

Parameters

Returns

Applies to

File(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Parameters

Returns

Applies to

File(Stream, String, String, Boolean)

Parameters

Returns

Remarks

Applies to

File(Stream, String)

Parameters

Returns

Remarks

Applies to

File(Byte[], String, String, Boolean)

Parameters

Returns

Applies to

File(Byte[], String)

Parameters

Returns

Applies to

File(Stream, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Parameters

Returns

Remarks

Applies to

File(Byte[], String, Boolean)

Parameters

Returns

Applies to

File(Byte[], String, String)

Parameters