Share via


CloudFile.DownloadToFileAsync Method

Definition

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.Task
Public Overridable Function DownloadToFileAsync (path As String, mode As FileMode) As Task

Parameters

path
String

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

mode
FileMode

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

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.Task
Public Overridable Function DownloadToFileAsync (path As String, mode As FileMode, cancellationToken As CancellationToken) As Task

Parameters

path
String

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

mode
FileMode

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

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.Task
Public Overridable Function DownloadToFileAsync (path As String, mode As FileMode, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext) As Task

Parameters

path
String

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

mode
FileMode

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

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.Task
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
String

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

mode
FileMode

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

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.Task
Public 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 Task

Parameters

path
String

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

mode
FileMode

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

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