Results.File メソッド

定義

名前空間:

Microsoft.AspNetCore.Http

アセンブリ:

Microsoft.AspNetCore.Http.Results.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

オーバーロード

File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	指定した path のファイルを応答に書き込みます。 これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。
File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)	バイト配列の内容を応答に書き込みます。 これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。 この API は、Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)のエイリアスです。
File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	指定した Stream を応答に書き込みます。 これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。 この API は、Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)のエイリアスです。

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

ソース:

Results.cs

指定した path のファイルを応答に書き込みます。

これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。

public static Microsoft.AspNetCore.Http.IResult File (string path, string? contentType = default, string? fileDownloadName = default, DateTimeOffset? lastModified = default, Microsoft.Net.Http.Headers.EntityTagHeaderValue? entityTag = default, bool enableRangeProcessing = false);

static member File : string * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Http.IResult

Public Shared Function File (path As String, Optional contentType As String = Nothing, Optional fileDownloadName As String = Nothing, Optional lastModified As Nullable(Of DateTimeOffset) = Nothing, Optional entityTag As EntityTagHeaderValue = Nothing, Optional enableRangeProcessing As Boolean = false) As IResult

パラメーター

path

String

ファイルへのパス。 ルート化されていない場合は、WebRootFileProviderに対する相対パスを解決します。

contentType

String

ファイルの Content-Type。

fileDownloadName

String

推奨されるファイル名。

lastModified

Nullable<DateTimeOffset>

ファイルが最後に変更された日時の DateTimeOffset。

entityTag

EntityTagHeaderValue

ファイルに関連付けられている EntityTagHeaderValue。

enableRangeProcessing

Boolean

範囲要求の処理を有効にするには、true に設定します。

戻り値

IResult

応答用に作成された IResult。

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

ソース:

Results.cs

バイト配列の内容を応答に書き込みます。

これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。

この API は、Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)のエイリアスです。

public static Microsoft.AspNetCore.Http.IResult File (byte[] fileContents, string? contentType = default, string? fileDownloadName = default, bool enableRangeProcessing = false, DateTimeOffset? lastModified = default, Microsoft.Net.Http.Headers.EntityTagHeaderValue? entityTag = default);

static member File : byte[] * string * string * bool * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Http.IResult

Public Shared Function File (fileContents As Byte(), Optional contentType As String = Nothing, Optional fileDownloadName As String = Nothing, Optional enableRangeProcessing As Boolean = false, Optional lastModified As Nullable(Of DateTimeOffset) = Nothing, Optional entityTag As EntityTagHeaderValue = Nothing) As IResult

パラメーター

fileContents

Byte[]

ファイルの内容。

contentType

String

ファイルの Content-Type。

fileDownloadName

String

推奨されるファイル名。

enableRangeProcessing

Boolean

範囲要求の処理を有効にするには、true に設定します。

lastModified

Nullable<DateTimeOffset>

ファイルが最後に変更された日時の DateTimeOffset。

entityTag

EntityTagHeaderValue

ファイルに関連付けられている EntityTagHeaderValue。

戻り値

IResult

応答用に作成された IResult。

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

ソース:

Results.cs

指定した Stream を応答に書き込みます。

これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。

この API は、Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)のエイリアスです。

public static Microsoft.AspNetCore.Http.IResult File (System.IO.Stream fileStream, string? contentType = default, string? fileDownloadName = default, DateTimeOffset? lastModified = default, Microsoft.Net.Http.Headers.EntityTagHeaderValue? entityTag = default, bool enableRangeProcessing = false);

static member File : System.IO.Stream * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue * bool -> Microsoft.AspNetCore.Http.IResult

Public Shared Function File (fileStream As Stream, Optional contentType As String = Nothing, Optional fileDownloadName As String = Nothing, Optional lastModified As Nullable(Of DateTimeOffset) = Nothing, Optional entityTag As EntityTagHeaderValue = Nothing, Optional enableRangeProcessing As Boolean = false) As IResult

パラメーター

fileStream

Stream

ファイルの内容を含む Stream。

contentType

String

ファイルの Content-Type。

fileDownloadName

String

Content-Disposition ヘッダーで使用するファイル名。

lastModified

Nullable<DateTimeOffset>

ファイルが最後に変更された日時の DateTimeOffset。 Last-Modified 応答ヘッダーを構成し、条件付き範囲要求を実行するために使用します。

entityTag

EntityTagHeaderValue

ETag 応答ヘッダーを構成し、条件付き要求を実行する EntityTagHeaderValue。

enableRangeProcessing

Boolean

範囲要求の処理を有効にするには、true に設定します。

戻り値

IResult

応答用に作成された IResult。

注釈

fileStream パラメーターは、応答の送信後に破棄されます。