Results.Stream メソッド

定義

名前空間:

Microsoft.AspNetCore.Http

アセンブリ:

Microsoft.AspNetCore.Http.Results.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

オーバーロード

Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	応答本文に直接書き込みを許可します。
Stream(PipeReader, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	指定した PipeReader の内容を応答に書き込みます。 これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。
Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	指定した Stream を応答に書き込みます。 これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。 この API は、File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)のエイリアスです。

Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

ソース:

Results.cs

応答本文に直接書き込みを許可します。

public static Microsoft.AspNetCore.Http.IResult Stream (Func<System.IO.Stream,System.Threading.Tasks.Task> streamWriterCallback, string? contentType = default, string? fileDownloadName = default, DateTimeOffset? lastModified = default, Microsoft.Net.Http.Headers.EntityTagHeaderValue? entityTag = default);

static member Stream : Func<System.IO.Stream, System.Threading.Tasks.Task> * string * string * Nullable<DateTimeOffset> * Microsoft.Net.Http.Headers.EntityTagHeaderValue -> Microsoft.AspNetCore.Http.IResult

Public Shared Function Stream (streamWriterCallback As Func(Of Stream, Task), Optional contentType As String = Nothing, Optional fileDownloadName As String = Nothing, Optional lastModified As Nullable(Of DateTimeOffset) = Nothing, Optional entityTag As EntityTagHeaderValue = Nothing) As IResult

パラメーター

streamWriterCallback

Func<Stream,Task>

ユーザーが応答本文に直接書き込むコールバック。

contentType

String

応答の Content-Type。 既定値は application/octet-streamです。

fileDownloadName

String

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

lastModified

Nullable<DateTimeOffset>

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

entityTag

EntityTagHeaderValue

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

戻り値

IResult

応答用に作成された IResult。

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

ソース:

Results.cs

指定した PipeReader の内容を応答に書き込みます。

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

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

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

Public Shared Function Stream (pipeReader As PipeReader, 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

パラメーター

pipeReader

PipeReader

応答に書き込む PipeReader。

contentType

String

応答の Content-Type。 既定値は application/octet-streamです。

fileDownloadName

String

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

lastModified

Nullable<DateTimeOffset>

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

entityTag

EntityTagHeaderValue

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

enableRangeProcessing

Boolean

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

戻り値

IResult

応答用に作成された IResult。

注釈

pipeReader パラメーターは、応答の送信後に完了します。

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

ソース:

Results.cs

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

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

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

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

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

Public Shared Function Stream (stream 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

パラメーター

stream

Stream

応答に書き込む Stream。

contentType

String

応答の Content-Type。 既定値は application/octet-streamです。

fileDownloadName

String

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

lastModified

Nullable<DateTimeOffset>

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

entityTag

EntityTagHeaderValue

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

enableRangeProcessing

Boolean

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

戻り値

IResult

応答用に作成された IResult。

注釈

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