Share via


CloudFile.BeginDownloadToFile Method

Definition

Overloads

BeginDownloadToFile(String, FileMode, AsyncCallback, Object)

Begins an asynchronous operation to download the contents of a file in the File service to a local file.

BeginDownloadToFile(String, FileMode, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to download the contents of a file in the File service to a local file.

BeginDownloadToFile(String, FileMode, AsyncCallback, Object)

Begins an asynchronous operation to download the contents of a file in the File service to a local file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.ICancellableAsyncResult BeginDownloadToFile (string path, System.IO.FileMode mode, AsyncCallback callback, object state);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BeginDownloadToFile : string * System.IO.FileMode * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
override this.BeginDownloadToFile : string * System.IO.FileMode * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
Public Overridable Function BeginDownloadToFile (path As String, mode As FileMode, callback As AsyncCallback, state As Object) As ICancellableAsyncResult

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.

callback
AsyncCallback

The callback delegate that will receive notification when the asynchronous operation completes.

state
Object

A user-defined object that will be passed to the callback delegate.

Returns

An ICancellableAsyncResult that references the asynchronous operation.

Attributes

Applies to

BeginDownloadToFile(String, FileMode, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)

Begins an asynchronous operation to download the contents of a file in the File service to a local file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.ICancellableAsyncResult BeginDownloadToFile (string path, System.IO.FileMode mode, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, AsyncCallback callback, object state);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member BeginDownloadToFile : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
override this.BeginDownloadToFile : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * AsyncCallback * obj -> Microsoft.Azure.Storage.ICancellableAsyncResult
Public Overridable Function BeginDownloadToFile (path As String, mode As FileMode, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, callback As AsyncCallback, state As Object) As ICancellableAsyncResult

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 file.

options
FileRequestOptions

A FileRequestOptions object that specifies additional options for the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

callback
AsyncCallback

The callback delegate that will receive notification when the asynchronous operation completes.

state
Object

A user-defined object that will be passed to the callback delegate.

Returns

An ICancellableAsyncResult that references the asynchronous operation.

Attributes

Applies to