CloudFile.DownloadToFileAsync Method (String, FileMode, AccessCondition, FileRequestOptions, OperationContext, CancellationToken) (Microsoft.WindowsAzure.Storage.File)
From Microsoft Windows Azure Storage Blob
C#
C++
F#
VB
CloudFile.::..DownloadToFileAsync Method (String, FileMode, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(String^, FileMode, AccessCondition^, FileRequestOptions^, OperationContext^, CancellationToken)(String, FileMode, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(String, FileMode, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)
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,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext operationContext,
CancellationToken cancellationToken
)
C++public:
[DoesServiceRequestAttribute]
virtual Task^ DownloadToFileAsync(
String^ path,
FileMode mode,
AccessCondition^ accessCondition,
FileRequestOptions^ options,
OperationContext^ operationContext,
CancellationToken cancellationToken
)
[<DoesServiceRequestAttribute>]
abstract DownloadToFileAsync :
path:string *
mode:FileMode *
accessCondition:AccessCondition *
options:FileRequestOptions *
operationContext:OperationContext *
cancellationToken:CancellationToken -> Task
[<DoesServiceRequestAttribute>]
override DownloadToFileAsync :
path:string *
mode:FileMode *
accessCondition:AccessCondition *
options:FileRequestOptions *
operationContext:OperationContext *
cancellationToken:CancellationToken -> Task
<DoesServiceRequestAttribute>
Public Overridable Function DownloadToFileAsync (
path As String,
mode As FileMode,
accessCondition As AccessCondition,
options As FileRequestOptions,
operationContext As OperationContext,
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.
- 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 cloud 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.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, AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken )
C++
public: [DoesServiceRequestAttribute] virtual Task^ DownloadToFileAsync( String^ path, FileMode mode, AccessCondition^ accessCondition, FileRequestOptions^ options, OperationContext^ operationContext, CancellationToken cancellationToken )
[<DoesServiceRequestAttribute>] abstract DownloadToFileAsync : path:string * mode:FileMode * accessCondition:AccessCondition * options:FileRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task [<DoesServiceRequestAttribute>] override DownloadToFileAsync : path:string * mode:FileMode * accessCondition:AccessCondition * options:FileRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task
<DoesServiceRequestAttribute> Public Overridable Function DownloadToFileAsync ( path As String, mode As FileMode, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, 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.
- 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 cloud 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.TaskSystem.Threading.Tasks::Task^System.Threading.Tasks.TaskSystem.Threading.Tasks.TaskA Task object that represents the current operation.