Share via

IHttpResponseBodyFeature.SendFileAsync Method

Definition

Namespace:
Microsoft.AspNetCore.Http.Features
Assembly:
Microsoft.AspNetCore.Http.Features.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0-preview.7.25380.108
Package:
Microsoft.AspNetCore.Http.Features v3.0.3
Package:
Microsoft.AspNetCore.Http.Features v3.1.18
Package:
Microsoft.AspNetCore.Http.Features v5.0.9
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
IHttpResponseBodyFeature.cs

Sends the requested file in the response body. A response may include multiple writes.

public System.Threading.Tasks.Task SendFileAsync(string path, long offset, long? count, System.Threading.CancellationToken cancellationToken = default);
abstract member SendFileAsync : string * int64 * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function SendFileAsync (path As String, offset As Long, count As Nullable(Of Long), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

path
String

The full disk path to the file.

offset
Int64

The offset in the file to start at.

count
Nullable<Int64>

The number of bytes to send, or null to send the remainder of the file.

cancellationToken
CancellationToken

A CancellationToken used to abort the transmission.

Returns

Task

Applies to