Results.File 方法

定义

命名空间:

Microsoft.AspNetCore.Http

程序集:

Microsoft.AspNetCore.Http.Results.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

重载

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)	将指定 path 处的文件写入响应。 如果范围) 不满意， Status206PartialContent 则支持 (范围 Status416RangeNotSatisfiable 请求。

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

将字节数组内容写入响应。

如果范围) 不满意， 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)

将指定的 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

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

enableRangeProcessing

Boolean

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

返回

IResult

为响应创建的 IResult 。

注解

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

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

将指定 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

文件的路径。 如果未获取 root 权限，则解析相对于 WebRootFileProvider的路径。

contentType

String

文件的 Content-Type。

fileDownloadName

String

建议的文件名。

lastModified

Nullable<DateTimeOffset>

DateTimeOffset上次修改文件时的 。

entityTag

EntityTagHeaderValue

与 EntityTagHeaderValue 文件关联的 。

enableRangeProcessing

Boolean

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

返回

IResult

为响应创建的 IResult 。