CloudFile.BeginDownloadToFile Method (String, FileMode, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object) (Microsoft.WindowsAzure.Storage.File)

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

Namespace:   Microsoft.WindowsAzure.Storage.File
Assembly:  Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Syntax

C#

Copy Code

 

[DoesServiceRequestAttribute]
public virtual ICancellableAsyncResult BeginDownloadToFile(
	string path,
	FileMode mode,
	AccessCondition accessCondition,
	FileRequestOptions options,
	OperationContext operationContext,
	AsyncCallback callback,
	object state
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual ICancellableAsyncResult^ BeginDownloadToFile(
	String^ path,
	FileMode mode,
	AccessCondition^ accessCondition,
	FileRequestOptions^ options,
	OperationContext^ operationContext,
	AsyncCallback^ callback,
	Object^ state
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract BeginDownloadToFile : 
        path:string *
        mode:FileMode *
        accessCondition:AccessCondition *
        options:FileRequestOptions *
        operationContext:OperationContext *
        callback:AsyncCallback *
        state:Object -> ICancellableAsyncResult
[<DoesServiceRequestAttribute>]
override BeginDownloadToFile : 
        path:string *
        mode:FileMode *
        accessCondition:AccessCondition *
        options:FileRequestOptions *
        operationContext:OperationContext *
        callback:AsyncCallback *
        state:Object -> ICancellableAsyncResult

VB

Copy Code

 

<DoesServiceRequestAttribute>
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

Type: System.StringSystem::String^System.StringSystem.String

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

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 access conditions for the file.

options

Type: Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File::FileRequestOptions^Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File.FileRequestOptions

A FileRequestOptions 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.

callback

Type: System.AsyncCallbackSystem::AsyncCallback^System.AsyncCallbackSystem.AsyncCallback

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

state

Type: System.ObjectSystem::Object^System.ObjectSystem.Object

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

Return Value

Type: Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage::ICancellableAsyncResult^Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage.ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

See Also

BeginDownloadToFile Overload
CloudFile Class
Microsoft.WindowsAzure.Storage.File Namespace

Return to top