CloudFile.DownloadRangeToByteArrayAsync Method (Byte[], Int32, Nullable, Nullable, AccessCondition, FileRequestOptions, OperationContext)

Windows Runtime Azure Storage Client Library

Downloads the contents of a file to a byte array.

Namespace: Microsoft.WindowsAzure.Storage.File
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Usage

Visual Basic
Dim instance As CloudFile
Dim target As Byte()
Dim index As Integer
Dim fileOffset As Nullable(Of Long)
Dim length As Nullable(Of Long)
Dim accessCondition As AccessCondition
Dim options As FileRequestOptions
Dim operationContext As OperationContext
Dim returnValue As IAsyncOperation(Of Integer)

returnValue = instance.DownloadRangeToByteArrayAsync(target, index, fileOffset, length, accessCondition, options, operationContext)

Syntax

Visual Basic
Public 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 IAsyncOperation(Of Integer)
C#
public IAsyncOperation<int> DownloadRangeToByteArrayAsync (
	byte[] target,
	int index,
	Nullable<long> fileOffset,
	Nullable<long> length,
	AccessCondition accessCondition,
	FileRequestOptions options,
	OperationContext operationContext
)
C++
public:
IAsyncOperation<int>^ DownloadRangeToByteArrayAsync (
	array<unsigned char>^ target, 
	int index, 
	Nullable<long long> fileOffset, 
	Nullable<long long> length, 
	AccessCondition^ accessCondition, 
	FileRequestOptions^ options, 
	OperationContext^ operationContext
)
J#
public IAsyncOperation<int> DownloadRangeToByteArrayAsync (
	byte[] target, 
	int index, 
	Nullable<long> fileOffset, 
	Nullable<long> length, 
	AccessCondition accessCondition, 
	FileRequestOptions options, 
	OperationContext operationContext
)
JScript
public function DownloadRangeToByteArrayAsync (
	target : byte[], 
	index : int, 
	fileOffset : Nullable<long>, 
	length : Nullable<long>, 
	accessCondition : AccessCondition, 
	options : FileRequestOptions, 
	operationContext : OperationContext
) : IAsyncOperation<int>

Parameters

target

The target byte array.

index

The starting offset in the byte array.

fileOffset

The starting offset of the data range, in bytes.

length

The length of the data range, in bytes.

accessCondition

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

options

A FileRequestOptions object that specifies additional options for the request.

operationContext

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

Return Value

The total number of bytes read into the buffer.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms

See Also