CloudBlob.DownloadRangeToStreamAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Storage.Blob

Assembly:: Microsoft.Azure.Storage.Blob.dll

Package:: Microsoft.Azure.Storage.Blob v11.2.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to download a range of bytes from a blob to a stream.
DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation to download a range of bytes from a blob to a stream.
DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)	Initiates an asynchronous operation to download a range of bytes from a blob to a stream.
DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>)	Initiates an asynchronous operation to download a range of bytes from a blob to a stream.
DownloadRangeToStreamAsync(Stream, Nullable<Int64>, Nullable<Int64>, CancellationToken)	Initiates an asynchronous operation to download a range of bytes from a blob to a stream.

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

Initiates an asynchronous operation to download a range of bytes from a blob 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.Blob.BlobRequestOptions 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.Blob.BlobRequestOptions * 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.Blob.BlobRequestOptions * 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 BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task

Parameters

target: Stream

A Stream object representing the target stream.

offset: Nullable<Int64>

The offset at which to begin downloading the blob, in bytes.

length: Nullable<Int64>

The length of the data to download from the blob, in bytes.

accessCondition: AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options: BlobRequestOptions

A BlobRequestOptions 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

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

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

Initiates an asynchronous operation to download a range of bytes from a blob 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.Blob.BlobRequestOptions 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.Blob.BlobRequestOptions * 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.Blob.BlobRequestOptions * 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 BlobRequestOptions, operationContext As OperationContext) As Task

Parameters

target: Stream

A Stream object representing the target stream.

offset: Nullable<Int64>

The offset at which to begin downloading the blob, in bytes.

length: Nullable<Int64>

The length of the data to download from the blob, in bytes.

accessCondition: AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options: BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext: OperationContext

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

Returns

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

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

Initiates an asynchronous operation to download a range of bytes from a blob 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.Blob.BlobRequestOptions 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.Blob.BlobRequestOptions * 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.Blob.BlobRequestOptions * 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 BlobRequestOptions, operationContext As OperationContext, progressHandler As IProgress(Of StorageProgress), cancellationToken As CancellationToken) As Task

Parameters

target: Stream

A Stream object representing the target stream.

offset: Nullable<Int64>

The offset at which to begin downloading the blob, in bytes.

length: Nullable<Int64>

The length of the data to download from the blob, in bytes.

accessCondition: AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options: BlobRequestOptions

A BlobRequestOptions 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

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

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

Initiates an asynchronous operation to download a range of bytes from a blob 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

A Stream object representing the target stream.

offset: Nullable<Int64>

The offset at which to begin downloading the blob, in bytes.

length: Nullable<Int64>

The length of the data to download from the blob, in bytes.

Returns

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

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

Initiates an asynchronous operation to download a range of bytes from a blob 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

A Stream object representing the target stream.

offset: Nullable<Int64>

The offset at which to begin downloading the blob, in bytes.

length: Nullable<Int64>

The length of the data to download from the blob, in bytes.

cancellationToken: CancellationToken

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

Returns

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

Share via

CloudBlob.DownloadRangeToStreamAsync Method

Definition

Overloads

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

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

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

Parameters

Returns

Applies to

Additional resources