ICloudBlob.DownloadToFileAsync Method (String, FileMode, AccessCondition, BlobRequestOptions, OperationContext) (Microsoft.WindowsAzure.Storage.Blob)
From Microsoft Windows Azure Storage Blob
C#
C++
F#
VB
ICloudBlob.::..DownloadToFileAsync Method (String, FileMode, AccessCondition, BlobRequestOptions, OperationContext)(String^, FileMode, AccessCondition^, BlobRequestOptions^, OperationContext^)(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext)(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext)
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
Task DownloadToFileAsync(
string path,
FileMode mode,
AccessCondition accessCondition,
BlobRequestOptions options,
OperationContext operationContext
)C++
Task^ DownloadToFileAsync(
String^ path,
FileMode mode,
AccessCondition^ accessCondition,
BlobRequestOptions^ options,
OperationContext^ operationContext
)
abstract DownloadToFileAsync :
path:string *
mode:FileMode *
accessCondition:AccessCondition *
options:BlobRequestOptions *
operationContext:OperationContext -> Task
Function DownloadToFileAsync (
path As String,
mode As FileMode,
accessCondition As AccessCondition,
options As BlobRequestOptions,
operationContext As OperationContext
) 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.
Return Value
Type:
System.Threading.Tasks.TaskSystem.Threading.Tasks::Task^System.Threading.Tasks.TaskSystem.Threading.Tasks.TaskA Task object that represents the asynchronous operation.
See Also
DownloadToFileAsync Overload
ICloudBlob Interface
Microsoft.WindowsAzure.Storage.Blob Namespace
Return to top
Initiates an asynchronous operation to download the contents of a blob to a file.
Syntax
Task DownloadToFileAsync(
string path,
FileMode mode,
AccessCondition accessCondition,
BlobRequestOptions options,
OperationContext operationContext
)C++
Task^ DownloadToFileAsync( String^ path, FileMode mode, AccessCondition^ accessCondition, BlobRequestOptions^ options, OperationContext^ operationContext )
abstract DownloadToFileAsync :
path:string *
mode:FileMode *
accessCondition:AccessCondition *
options:BlobRequestOptions *
operationContext:OperationContext -> TaskFunction DownloadToFileAsync ( path As String, mode As FileMode, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext ) 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.
Return Value
Type: System.Threading.Tasks.TaskSystem.Threading.Tasks::Task^System.Threading.Tasks.TaskSystem.Threading.Tasks.TaskA Task object that represents the asynchronous operation.
See Also
DownloadToFileAsync Overload
ICloudBlob Interface
Microsoft.WindowsAzure.Storage.Blob Namespace