Storage Client Library for Windows Phone (Version 7.0)

Returns a task that performs an asynchronous operation to download the contents of a file in the File service to a local file.

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

Syntax

C#

Copy Code

 

[DoesServiceRequestAttribute]
public virtual Task DownloadToFileAsync(
	string path,
	FileMode mode,
	CancellationToken cancellationToken
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual Task^ DownloadToFileAsync(
	String^ path,
	FileMode mode,
	CancellationToken cancellationToken
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract DownloadToFileAsync : 
        path:string *
        mode:FileMode *
        cancellationToken:CancellationToken -> Task
[<DoesServiceRequestAttribute>]
override DownloadToFileAsync : 
        path:string *
        mode:FileMode *
        cancellationToken:CancellationToken -> Task

VB

Copy Code

 

<DoesServiceRequestAttribute>
Public Overridable Function DownloadToFileAsync (
	path As String,
	mode As FileMode,
	cancellationToken As CancellationToken
) As Task

Parameters

path

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

The path to the target file in the local file system.

mode

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

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

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 current operation.

See Also

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

Return to top