CloudFile.DownloadToFileAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| DownloadToFileAsync(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. |
| DownloadToFileAsync(String, FileMode, CancellationToken) |
Returns a task that performs an asynchronous operation to download the contents of a file in the File service to a local file. |
| DownloadToFileAsync(String, FileMode, AccessCondition, FileRequestOptions, OperationContext) |
Returns a task that performs an asynchronous operation to download the contents of a file in the File service to a local file. |
| DownloadToFileAsync(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. |
| DownloadToFileAsync(String, FileMode, AccessCondition, FileRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken) |
Returns a task that performs an asynchronous operation to download the contents of a file in the File service to a local file. |
DownloadToFileAsync(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.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync (string path, System.IO.FileMode mode);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode) As TaskParameters
- path
- String
The path to the target file in the local file system.
Returns
A Task object that represents the current operation.
- Attributes
Applies to
DownloadToFileAsync(String, FileMode, CancellationToken)
Returns a task that performs an asynchronous operation to download the contents of a file in the File service to a local file.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync (string path, System.IO.FileMode mode, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode, cancellationToken As CancellationToken) As TaskParameters
- path
- String
The path to the target file in the local file system.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task object that represents the current operation.
- Attributes
Applies to
DownloadToFileAsync(String, FileMode, AccessCondition, FileRequestOptions, OperationContext)
Returns a task that performs an asynchronous operation to download the contents of a file in the File service to a local file.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync (string path, System.IO.FileMode mode, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext) As TaskParameters
- path
- String
The path to the target file in the local file system.
- accessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the cloud file.
- options
- FileRequestOptions
An FileRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
A Task object that represents the current operation.
- Attributes
Applies to
DownloadToFileAsync(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.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync (string path, System.IO.FileMode mode, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As TaskParameters
- path
- String
The path to the target file in the local file system.
- accessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the cloud file.
- options
- FileRequestOptions
An FileRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task object that represents the current operation.
- Attributes
Applies to
DownloadToFileAsync(String, FileMode, AccessCondition, FileRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)
Returns a task that performs an asynchronous operation to download the contents of a file in the File service to a local file.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync (string path, System.IO.FileMode mode, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> progressHandler, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DownloadToFileAsync (path As String, mode As FileMode, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, progressHandler As IProgress(Of StorageProgress), cancellationToken As CancellationToken) As TaskParameters
- path
- String
The path to the target file in the local file system.
- accessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the cloud file.
- options
- FileRequestOptions
An FileRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
- progressHandler
- IProgress<StorageProgress>
A IProgress<T> object to handle StorageProgress messages.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task object that represents the current operation.
- Attributes
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for