StreamResponseBodyFeature.SendFileAsync Method

Definition

Namespace:

Microsoft.AspNetCore.Http

Assembly:

Microsoft.AspNetCore.Http.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Copies the specified file segment to the given response stream. This calls StartAsync if it has not previously been called.

public:
 virtual System::Threading::Tasks::Task ^ SendFileAsync(System::String ^ path, long offset, Nullable<long> count, System::Threading::CancellationToken cancellationToken);

public virtual System.Threading.Tasks.Task SendFileAsync (string path, long offset, long? count, System.Threading.CancellationToken cancellationToken);

abstract member SendFileAsync : string * int64 * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.SendFileAsync : string * int64 * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function SendFileAsync (path As String, offset As Long, count As Nullable(Of Long), cancellationToken As CancellationToken) 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

Implements

SendFileAsync(String, Int64, Nullable<Int64>, CancellationToken)