Storage Client Library for Windows Phone (Version 7.0)

Returns a task that performs an asynchronous operation to download the contents of a file to a byte array.

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

Syntax

C#

Copy Code

 

[DoesServiceRequestAttribute]
public virtual Task<int> DownloadRangeToByteArrayAsync(
	byte[] target,
	int index,
	Nullable<long> fileOffset,
	Nullable<long> length,
	AccessCondition accessCondition,
	FileRequestOptions options,
	OperationContext operationContext,
	CancellationToken cancellationToken
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual Task<int>^ DownloadRangeToByteArrayAsync(
	array<unsigned char>^ target,
	int index,
	Nullable<long long> fileOffset,
	Nullable<long long> length,
	AccessCondition^ accessCondition,
	FileRequestOptions^ options,
	OperationContext^ operationContext,
	CancellationToken cancellationToken
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract DownloadRangeToByteArrayAsync : 
        target:byte[] *
        index:int *
        fileOffset:Nullable<int64> *
        length:Nullable<int64> *
        accessCondition:AccessCondition *
        options:FileRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<int>
[<DoesServiceRequestAttribute>]
override DownloadRangeToByteArrayAsync : 
        target:byte[] *
        index:int *
        fileOffset:Nullable<int64> *
        length:Nullable<int64> *
        accessCondition:AccessCondition *
        options:FileRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<int>

VB

Copy Code

 

<DoesServiceRequestAttribute>
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

Type: System.Byte[]array<System::Byte>^System.Byte[]System.Byte()

The target byte array.

index

Type: System.Int32System::Int32System.Int32System.Int32

The starting offset in the byte array.

fileOffset

Type: System.Nullable<Int64>System::Nullable<Int64>System.Nullable<Int64>System.Nullable(Of Int64)

The starting offset of the data range, in bytes.

length

Type: System.Nullable<Int64>System::Nullable<Int64>System.Nullable<Int64>System.Nullable(Of Int64)

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

accessCondition

Type: Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage::AccessCondition^Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage.AccessCondition

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

options

Type: Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File::FileRequestOptions^Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File.FileRequestOptions

An FileRequestOptions object that specifies additional options for the request.

operationContext

Type: Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext

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

cancellationToken

Type: System.Threading.CancellationTokenSystem.Threading::CancellationTokenSystem.Threading.CancellationTokenSystem.Threading.CancellationToken

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

Return Value

Type: System.Threading.Tasks.Task<Int32>System.Threading.Tasks::Task<Int32>^System.Threading.Tasks.Task<Int32>System.Threading.Tasks.Task(Of Int32)

A Task object that represents the current operation.

See Also

DownloadRangeToByteArrayAsync Overload
CloudFile Class
Microsoft.WindowsAzure.Storage.File Namespace

Return to top