CloudFile.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>, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)
Returns a task that performs an asynchronous operation to download the contents of a file to a byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync (byte[] target, int index, long? fileOffset, 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 DownloadRangeToByteArrayAsync : byte[] * int * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * 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.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>Public Overridable Function DownloadRangeToByteArrayAsync (target As Byte(), index As Integer, fileOffset As Nullable(Of Long), length As Nullable(Of Long), accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of Integer)Parameters
- target
- Byte[]
The target byte array.
- index
- Int32
The starting offset in the byte array.
- accessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the file.
- options
- FileRequestOptions
An 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
DownloadRangeToByteArrayAsync(Byte[], Int32, Nullable<Int64>, Nullable<Int64>)
Returns a task that performs an asynchronous operation to download the contents of a file to a byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync (byte[] target, int index, long? fileOffset, 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, fileOffset As Nullable(Of Long), length As Nullable(Of Long)) As Task(Of Integer)Parameters
- target
- Byte[]
The target byte array.
- index
- Int32
The starting offset in the byte array.
Returns
A Task object that represents the current operation.
- Attributes
Applies to
DownloadRangeToByteArrayAsync(Byte[], Int32, Nullable<Int64>, Nullable<Int64>, CancellationToken)
Returns a task that performs an asynchronous operation to download the contents of a file to a byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync (byte[] target, int index, long? fileOffset, 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, fileOffset As Nullable(Of Long), length As Nullable(Of Long), cancellationToken As CancellationToken) As Task(Of Integer)Parameters
- target
- Byte[]
The target byte array.
- index
- Int32
The starting offset in the byte array.
- 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
DownloadRangeToByteArrayAsync(Byte[], Int32, Nullable<Int64>, Nullable<Int64>, AccessCondition, FileRequestOptions, OperationContext)
Returns a task that performs an asynchronous operation to download the contents of a file to a byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync (byte[] target, int index, long? fileOffset, long? length, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions 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.File.FileRequestOptions * 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.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<int>Public Overridable Function DownloadRangeToByteArrayAsync (target As Byte(), index As Integer, fileOffset As Nullable(Of Long), length As Nullable(Of Long), accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext) As Task(Of Integer)Parameters
- target
- Byte[]
The target byte array.
- index
- Int32
The starting offset in the byte array.
- accessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the file.
- options
- FileRequestOptions
An 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
DownloadRangeToByteArrayAsync(Byte[], Int32, 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 byte array.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<int> DownloadRangeToByteArrayAsync (byte[] target, int index, long? fileOffset, 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 DownloadRangeToByteArrayAsync : byte[] * int * 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<int>
override this.DownloadRangeToByteArrayAsync : byte[] * int * 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<int>Public Overridable Function DownloadRangeToByteArrayAsync (target As Byte(), index As Integer, fileOffset 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(Of Integer)Parameters
- target
- Byte[]
The target byte array.
- index
- Int32
The starting offset in the byte array.
- accessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the file.
- options
- FileRequestOptions
An 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
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for