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)

Source:

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

文件的内容类型。

fileDownloadName

String

建议的文件名。

lastModified

Nullable<DateTimeOffset>

上次修改文件时的 DateTimeOffset。

entityTag

EntityTagHeaderValue

与文件关联的 EntityTagHeaderValue。

enableRangeProcessing

Boolean

设置为 true 以启用范围请求处理。

返回

IResult

为响应创建的 IResult。

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

Source:

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

文件的内容类型。

fileDownloadName

String

建议的文件名。

enableRangeProcessing

Boolean

设置为 true 以启用范围请求处理。

lastModified

Nullable<DateTimeOffset>

上次修改文件时的 DateTimeOffset。

entityTag

EntityTagHeaderValue

与文件关联的 EntityTagHeaderValue。

返回

IResult

为响应创建的 IResult。

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

Source:

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

文件的内容类型。

fileDownloadName

String

要用于 Content-Disposition 标头的文件名。

lastModified

Nullable<DateTimeOffset>

上次修改文件时的 DateTimeOffset。 用于配置 Last-Modified 响应标头并执行条件范围请求。

entityTag

EntityTagHeaderValue

要配置 ETag 响应标头并执行条件请求的 EntityTagHeaderValue。

enableRangeProcessing

Boolean

设置为 true 以启用范围请求处理。

返回

IResult

为响应创建的 IResult。

注解

发送响应后，将释放 fileStream 参数。