Storage Client Library for Windows Phone (Version 7.0)

Initiates an asynchronous operation to download the contents of a blob to a file.

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

Syntax

C#

Copy Code

 

Task DownloadToFileAsync(
	string path,
	FileMode mode,
	AccessCondition accessCondition,
	BlobRequestOptions options,
	OperationContext operationContext,
	CancellationToken cancellationToken
)

C++

Copy Code

 

Task^ DownloadToFileAsync(
	String^ path,
	FileMode mode,
	AccessCondition^ accessCondition,
	BlobRequestOptions^ options,
	OperationContext^ operationContext,
	CancellationToken cancellationToken
)

F#

Copy Code

 

abstract DownloadToFileAsync : 
        path:string *
        mode:FileMode *
        accessCondition:AccessCondition *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task

VB

Copy Code

 

Function DownloadToFileAsync (
	path As String,
	mode As FileMode,
	accessCondition As AccessCondition,
	options As BlobRequestOptions,
	operationContext As OperationContext,
	cancellationToken As CancellationToken
) As Task

Parameters

path

Type: System.StringSystem::String^System.StringSystem.String

A string containing the path to the target file.

mode

Type: System.IO.FileModeSystem.IO::FileModeSystem.IO.FileModeSystem.IO.FileMode

A FileMode enumeration value that determines how to open or create the file.

accessCondition

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

An AccessCondition object that represents the condition that must be met in order for the request to proceed.

options

Type: Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob::BlobRequestOptions^Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob.BlobRequestOptions

A BlobRequestOptions 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.TaskSystem.Threading.Tasks::Task^System.Threading.Tasks.TaskSystem.Threading.Tasks.Task

A Task object that represents the asynchronous operation.

See Also

DownloadToFileAsync Overload
ICloudBlob Interface
Microsoft.WindowsAzure.Storage.Blob Namespace

Return to top