CloudBlob.DownloadToFileAsync Method

Definition

Overloads

DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)

Downloads the contents of a blob to a file.

DownloadToFileAsync(String, FileMode)

Initiates an asynchronous operation to download the contents of a blob to a file.

DownloadToFileAsync(String, FileMode, CancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a file.

DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation to download the contents of a blob to a file.

DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a file.

DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)

Downloads the contents of a blob to a 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.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> progressHandler, System.Threading.CancellationToken cancellationToken);
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * 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.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

path
String

A string containing the file path providing the blob content.

mode
FileMode

A FileMode enumeration value that specifies how to open the file.

accessCondition
AccessCondition

An AccessCondition object that represents the access conditions for the blob.

options
BlobRequestOptions

A BlobRequestOptions 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

An Task that represents an asynchronous action.

Attributes

DownloadToFileAsync(String, FileMode)

Initiates an asynchronous operation to download the contents of a blob to a file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync (string path, System.IO.FileMode mode);
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

A string containing the path to the target file.

mode
FileMode

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

Returns

A Task object that represents the asynchronous operation.

Attributes

DownloadToFileAsync(String, FileMode, CancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToFileAsync (string path, System.IO.FileMode mode, System.Threading.CancellationToken cancellationToken);
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

Parameters

path
String

A string containing the path to the target file.

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 asynchronous operation.

Attributes

DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation to download the contents of a blob to a 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.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task
override this.DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task

Parameters

path
String

A string containing the path to the target file.

mode
FileMode

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

accessCondition
AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed.

options
BlobRequestOptions

A BlobRequestOptions 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 asynchronous operation.

Attributes

DownloadToFileAsync(String, FileMode, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a 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.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);
abstract member DownloadToFileAsync : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * 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.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

path
String

A string containing the path to the target file.

mode
FileMode

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

accessCondition
AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed.

options
BlobRequestOptions

A BlobRequestOptions 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 asynchronous operation.

Attributes

Applies to