CloudFile.DownloadToFileAsync Method (String, FileMode) (Microsoft.WindowsAzure.Storage.File)
From Microsoft Windows Azure Storage Blob
C#
C++
F#
VB
CloudFile.::..DownloadToFileAsync Method (String, FileMode)(String^, FileMode)(String, FileMode)(String, FileMode)
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
[DoesServiceRequestAttribute]
public virtual Task DownloadToFileAsync(
string path,
FileMode mode
)
C++
public:
[DoesServiceRequestAttribute]
virtual Task^ DownloadToFileAsync(
String^ path,
FileMode mode
)
[<DoesServiceRequestAttribute>]
abstract DownloadToFileAsync :
path:string *
mode:FileMode -> Task
[<DoesServiceRequestAttribute>]
override DownloadToFileAsync :
path:string *
mode:FileMode -> Task
<DoesServiceRequestAttribute>
Public Overridable Function DownloadToFileAsync (
path As String,
mode As FileMode
) 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.
Return Value
Type:
System.Threading.Tasks.TaskSystem.Threading.Tasks::Task^System.Threading.Tasks.TaskSystem.Threading.Tasks.TaskA Task object that represents the current operation.
Return to top
Returns a task that performs an asynchronous operation to download the contents of a file in the File service to a local file.
Syntax
[DoesServiceRequestAttribute] public virtual Task DownloadToFileAsync( string path, FileMode mode )
C++
public: [DoesServiceRequestAttribute] virtual Task^ DownloadToFileAsync( String^ path, FileMode mode )
[<DoesServiceRequestAttribute>] abstract DownloadToFileAsync : path:string * mode:FileMode -> Task [<DoesServiceRequestAttribute>] override DownloadToFileAsync : path:string * mode:FileMode -> Task
<DoesServiceRequestAttribute> Public Overridable Function DownloadToFileAsync ( path As String, mode As FileMode ) 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.
Return Value
Type: System.Threading.Tasks.TaskSystem.Threading.Tasks::Task^System.Threading.Tasks.TaskSystem.Threading.Tasks.TaskA Task object that represents the current operation.