CloudBlob.DownloadRangeToByteArrayAsync Method
Definition
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
DownloadRangeToByteArrayAsync(Byte[], Int32, Nullable<Int64>, Nullable<Int64>)
Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, long? length);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> -> System.Threading.Tasks.Task<int>
override this.DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> -> System.Threading.Tasks.Task<int>Public Overridable Function DownloadRangeToByteArrayAsync (target As Byte(), index As Integer, blobOffset As Nullable(Of Long), length As Nullable(Of Long)) As Task(Of Integer)Parameters
- target
- System.Byte[]
The target byte array.
- index
- System.Int32
The starting offset in the byte array.
- blobOffset
- System.Nullable<System.Int64>
The starting offset of the data range, in bytes.
- length
- System.Nullable<System.Int64>
The length of the data to download from the blob, in bytes.
Returns
A System.Threading.Tasks.Task`1 object of type int that represents the asynchronous operation.
- Attributes
Applies to
DownloadRangeToByteArrayAsync(Byte[], Int32, Nullable<Int64>, Nullable<Int64>, CancellationToken)
Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, long? length, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>Public Overridable Function DownloadRangeToByteArrayAsync (target As Byte(), index As Integer, blobOffset As Nullable(Of Long), length As Nullable(Of Long), cancellationToken As CancellationToken) As Task(Of Integer)Parameters
- target
- System.Byte[]
The target byte array.
- index
- System.Int32
The starting offset in the byte array.
- blobOffset
- System.Nullable<System.Int64>
The starting offset of the data range, in bytes.
- length
- System.Nullable<System.Int64>
The length of the data to download from the blob, in bytes.
- cancellationToken
- System.Threading.CancellationToken
A System.Threading.CancellationToken to observe while waiting for a task to complete.
Returns
A System.Threading.Tasks.Task`1 object of type int that represents the asynchronous operation.
- Attributes
Applies to
DownloadRangeToByteArrayAsync(Byte[], Int32, Nullable<Int64>, Nullable<Int64>, AccessCondition, BlobRequestOptions, OperationContext)
Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, long? length, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<int>
override this.DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<int>Public Overridable Function DownloadRangeToByteArrayAsync (target As Byte(), index As Integer, blobOffset As Nullable(Of Long), length As Nullable(Of Long), accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext) As Task(Of Integer)Parameters
- target
- System.Byte[]
The target byte array.
- index
- System.Int32
The starting offset in the byte array.
- blobOffset
- System.Nullable<System.Int64>
The starting offset of the data range, in bytes.
- length
- System.Nullable<System.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.
- 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
A System.Threading.Tasks.Task`1 object of type int that represents the asynchronous operation.
- Attributes
Applies to
DownloadRangeToByteArrayAsync(Byte[], Int32, Nullable<Int64>, Nullable<Int64>, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)
Initiates an asynchronous operation to download a range of bytes from a blob to a byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, 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 DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>Public Overridable Function DownloadRangeToByteArrayAsync (target As Byte(), index As Integer, blobOffset As Nullable(Of Long), length As Nullable(Of Long), accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of Integer)Parameters
- target
- System.Byte[]
The target byte array.
- index
- System.Int32
The starting offset in the byte array.
- blobOffset
- System.Nullable<System.Int64>
The starting offset of the data range, in bytes.
- length
- System.Nullable<System.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.
- 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
- System.Threading.CancellationToken
A System.Threading.CancellationToken to observe while waiting for a task to complete.
Returns
A System.Threading.Tasks.Task`1 object of type int that represents the asynchronous operation.
- Attributes
Applies to
DownloadRangeToByteArrayAsync(Byte[], Int32, 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 byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync(byte[] target, int index, long? blobOffset, 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 DownloadRangeToByteArrayAsync : byte[] * int * 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<int>
override this.DownloadRangeToByteArrayAsync : byte[] * int * 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<int>Public Overridable Function DownloadRangeToByteArrayAsync (target As Byte(), index As Integer, blobOffset 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(Of Integer)Parameters
- target
- System.Byte[]
The target byte array.
- index
- System.Int32
The starting offset in the byte array.
- blobOffset
- System.Nullable<System.Int64>
The starting offset of the data range, in bytes.
- length
- System.Nullable<System.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.
- 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
- System.IProgress<StorageProgress>
A System.IProgress`1 object to handle StorageProgress messages.
- cancellationToken
- System.Threading.CancellationToken
A System.Threading.CancellationToken to observe while waiting for a task to complete.
Returns
A System.Threading.Tasks.Task`1 object of type int that represents the asynchronous operation.
- Attributes