ControllerBase.PhysicalFile Method

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.Mvc.Core v2.0.0

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

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

Overloads

PhysicalFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Returns the file specified by `physicalPath` (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).
PhysicalFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Returns the file specified by `physicalPath` (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).
PhysicalFile(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Returns the file specified by `physicalPath` (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
PhysicalFile(String, String, String, Boolean)	Returns the file specified by `physicalPath` (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).
PhysicalFile(String, String, Boolean)	Returns the file specified by `physicalPath` (Status200OK) with the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
PhysicalFile(String, String, String)	Returns the file specified by `physicalPath` (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).
PhysicalFile(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Returns the file specified by `physicalPath` (Status200OK), and the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
PhysicalFile(String, String)	Returns the file specified by `physicalPath` (Status200OK) with the specified `contentType` as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).

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

Returns the file specified by physicalPath (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::PhysicalFileResult ^ PhysicalFile(System::String ^ physicalPath, 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.PhysicalFileResult PhysicalFile (string physicalPath, string contentType, string fileDownloadName, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag, bool enableRangeProcessing);

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

Public Overridable Function PhysicalFile (physicalPath As String, contentType As String, fileDownloadName As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue, enableRangeProcessing As Boolean) As PhysicalFileResult

Parameters

physicalPath: String

The path to the file. The path must be an absolute path.

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

PhysicalFileResult

The created PhysicalFileResult for the response.

Attributes: NonActionAttribute

Applies to

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

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

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

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

Public Overridable Function PhysicalFile (physicalPath As String, contentType As String, fileDownloadName As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue) As PhysicalFileResult

Parameters

physicalPath: String

The path to the file. The path must be an absolute path.

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

PhysicalFileResult

The created PhysicalFileResult for the response.

Attributes: NonActionAttribute

Applies to

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

Returns the file specified by physicalPath (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::PhysicalFileResult ^ PhysicalFile(System::String ^ physicalPath, System::String ^ contentType, Nullable<DateTimeOffset> lastModified, Microsoft::Net::Http::Headers::EntityTagHeaderValue ^ entityTag, bool enableRangeProcessing);

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

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

Public Overridable Function PhysicalFile (physicalPath As String, contentType As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue, enableRangeProcessing As Boolean) As PhysicalFileResult

Parameters

physicalPath: String

The path to the file. The path must be an absolute path.

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

PhysicalFileResult

The created PhysicalFileResult for the response.

Attributes: NonActionAttribute

Applies to

PhysicalFile(String, String, String, Boolean)

Returns the file specified by physicalPath (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::PhysicalFileResult ^ PhysicalFile(System::String ^ physicalPath, System::String ^ contentType, System::String ^ fileDownloadName, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.PhysicalFileResult PhysicalFile (string physicalPath, string contentType, string fileDownloadName, bool enableRangeProcessing);

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

Public Overridable Function PhysicalFile (physicalPath As String, contentType As String, fileDownloadName As String, enableRangeProcessing As Boolean) As PhysicalFileResult

Parameters

physicalPath: String

The path to the file. The path must be an absolute path.

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

PhysicalFileResult

The created PhysicalFileResult for the response.

Attributes: NonActionAttribute

Applies to

PhysicalFile(String, String, Boolean)

Returns the file specified by physicalPath (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::PhysicalFileResult ^ PhysicalFile(System::String ^ physicalPath, System::String ^ contentType, bool enableRangeProcessing);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.PhysicalFileResult PhysicalFile (string physicalPath, string contentType, bool enableRangeProcessing);

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

Public Overridable Function PhysicalFile (physicalPath As String, contentType As String, enableRangeProcessing As Boolean) As PhysicalFileResult

Parameters

physicalPath: String

The path to the file. The path must be an absolute path.

contentType: String

The Content-Type of the file.

enableRangeProcessing: Boolean

Set to true to enable range requests processing.

Returns

PhysicalFileResult

The created PhysicalFileResult for the response.

Attributes: NonActionAttribute

Applies to

PhysicalFile(String, String, String)

public:
 virtual Microsoft::AspNetCore::Mvc::PhysicalFileResult ^ PhysicalFile(System::String ^ physicalPath, System::String ^ contentType, System::String ^ fileDownloadName);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.PhysicalFileResult PhysicalFile (string physicalPath, string contentType, string fileDownloadName);

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

Public Overridable Function PhysicalFile (physicalPath As String, contentType As String, fileDownloadName As String) As PhysicalFileResult

Parameters

physicalPath: String

The path to the file. The path must be an absolute path.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

Returns

PhysicalFileResult

The created PhysicalFileResult for the response.

Attributes: NonActionAttribute

Applies to

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

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

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.PhysicalFileResult PhysicalFile (string physicalPath, string contentType, DateTimeOffset? lastModified, Microsoft.Net.Http.Headers.EntityTagHeaderValue entityTag);

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

Public Overridable Function PhysicalFile (physicalPath As String, contentType As String, lastModified As Nullable(Of DateTimeOffset), entityTag As EntityTagHeaderValue) As PhysicalFileResult

Parameters

physicalPath: String

The path to the file. The path must be an absolute path.

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

PhysicalFileResult

The created PhysicalFileResult for the response.

Attributes: NonActionAttribute

Applies to

PhysicalFile(String, String)

public:
 virtual Microsoft::AspNetCore::Mvc::PhysicalFileResult ^ PhysicalFile(System::String ^ physicalPath, System::String ^ contentType);

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.PhysicalFileResult PhysicalFile (string physicalPath, string contentType);

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

Public Overridable Function PhysicalFile (physicalPath As String, contentType As String) As PhysicalFileResult

Parameters

physicalPath: String

The path to the file. The path must be an absolute path.

contentType: String

The Content-Type of the file.

Returns

PhysicalFileResult

The created PhysicalFileResult for the response.

Attributes: NonActionAttribute

Applies to

ControllerBase.PhysicalFile Method

Definition

Overloads

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

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

PhysicalFile(String, String, String, Boolean)

Parameters

Returns

Applies to

PhysicalFile(String, String, Boolean)

Parameters

Returns

Applies to

PhysicalFile(String, String, String)

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

PhysicalFile(String, String)

Parameters

Returns

Applies to

Is this page helpful?

Is this page helpful?