Share via

CloudFile.DownloadRangeToByteArray Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Storage.File
Assembly:
Microsoft.Azure.Storage.File.dll
Package:
Microsoft.Azure.Storage.File v11.2.3

Downloads the contents of a file to a byte array.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual int DownloadRangeToByteArray (byte[] target, int index, long? fileOffset, long? length, Microsoft.Azure.Storage.AccessCondition accessCondition = default, Microsoft.Azure.Storage.File.FileRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadRangeToByteArray : byte[] * int * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> int
override this.DownloadRangeToByteArray : byte[] * int * Nullable<int64> * Nullable<int64> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> int
Public Overridable Function DownloadRangeToByteArray (target As Byte(), index As Integer, fileOffset As Nullable(Of Long), length As Nullable(Of Long), Optional accessCondition As AccessCondition = Nothing, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As Integer

Parameters

target
Byte[]

The target byte array.

index
Int32

The starting offset in the byte array.

fileOffset
Nullable<Int64>

The starting offset of the data range, in bytes.

length
Nullable<Int64>

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

accessCondition
AccessCondition

An AccessCondition object that represents the access conditions for the file.

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

Int32

The total number of bytes read into the buffer.

Attributes
DoesServiceRequestAttribute

Applies to