Share via


CloudFile.DownloadRangeToStreamAsync Method

Definition

Overloads

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, FileRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, CancellationToken)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, FileRequestOptions, OperationContext)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, FileRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadRangeToStreamAsync (System.IO.Stream target, long? offset, long? length, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> progressHandler, System.Threading.CancellationToken cancellationToken);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function DownloadRangeToStreamAsync (target As Stream, offset As Nullable(Of Long), length As Nullable(Of Long), accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, progressHandler As IProgress(Of StorageProgress), cancellationToken As CancellationToken) As Task

Parameters

target
Stream

The target stream.

offset
Nullable<Int64>

The starting offset of the data range, in bytes.

length
Nullable<Int64>

The length of the data range, in bytes.

accessCondition
AccessCondition

An AccessCondition object that represents the access conditions for the file. If null, no condition is used.

options
FileRequestOptions

A FileRequestOptions object that specifies additional options for the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

progressHandler
IProgress<StorageProgress>

A IProgress<T> object to handle StorageProgress messages.

cancellationToken
CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

A Task object that represents the current operation.

Attributes

Applies to

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadRangeToStreamAsync (System.IO.Stream target, long? offset, long? length, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function DownloadRangeToStreamAsync (target As Stream, offset As Nullable(Of Long), length As Nullable(Of Long), accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task

Parameters

target
Stream

The target stream.

offset
Nullable<Int64>

The starting offset of the data range, in bytes.

length
Nullable<Int64>

The length of the data range, in bytes.

accessCondition
AccessCondition

An AccessCondition object that represents the access conditions for the file. If null, no condition is used.

options
FileRequestOptions

A FileRequestOptions object that specifies additional options for the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken
CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

A Task object that represents the current operation.

Attributes

Applies to

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadRangeToStreamAsync (System.IO.Stream target, long? offset, long? length);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> -> System.Threading.Tasks.Task
override this.DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> -> System.Threading.Tasks.Task
Public Overridable Function DownloadRangeToStreamAsync (target As Stream, offset As Nullable(Of Long), length As Nullable(Of Long)) As Task

Parameters

target
Stream

The target stream.

offset
Nullable<Int64>

The starting offset of the data range, in bytes.

length
Nullable<Int64>

The length of the data range, in bytes.

Returns

A Task object that represents the current operation.

Attributes

Applies to

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, CancellationToken)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadRangeToStreamAsync (System.IO.Stream target, long? offset, long? length, System.Threading.CancellationToken cancellationToken);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function DownloadRangeToStreamAsync (target As Stream, offset As Nullable(Of Long), length As Nullable(Of Long), cancellationToken As CancellationToken) As Task

Parameters

target
Stream

The target stream.

offset
Nullable<Int64>

The starting offset of the data range, in bytes.

length
Nullable<Int64>

The length of the data range, in bytes.

cancellationToken
CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

A Task object that represents the current operation.

Attributes

Applies to

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, FileRequestOptions, OperationContext)

Returns a task that performs an asynchronous operation to download the contents of a file to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadRangeToStreamAsync (System.IO.Stream target, long? offset, long? length, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task
override this.DownloadRangeToStreamAsync : System.IO.Stream * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task
Public Overridable Function DownloadRangeToStreamAsync (target As Stream, offset As Nullable(Of Long), length As Nullable(Of Long), accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext) As Task

Parameters

target
Stream

The target stream.

offset
Nullable<Int64>

The starting offset of the data range, in bytes.

length
Nullable<Int64>

The length of the data range, in bytes.

accessCondition
AccessCondition

An AccessCondition object that represents the access conditions for the file. If null, no condition is used.

options
FileRequestOptions

A FileRequestOptions object that specifies additional options for the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

Returns

A Task object that represents the current operation.

Attributes

Applies to