CloudFile.BeginDownloadToFile Method (String, FileMode, AsyncCallback, Object) (Microsoft.WindowsAzure.Storage.File)
From Microsoft Windows Azure Storage Blob
C#
C++
F#
VB
CloudFile.::..BeginDownloadToFile Method (String, FileMode, AsyncCallback, Object)(String^, FileMode, AsyncCallback^, Object^)(String, FileMode, AsyncCallback, Object)(String, FileMode, AsyncCallback, Object)
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
[DoesServiceRequestAttribute]
public virtual ICancellableAsyncResult BeginDownloadToFile(
string path,
FileMode mode,
AsyncCallback callback,
object state
)
C++public:
[DoesServiceRequestAttribute]
virtual ICancellableAsyncResult^ BeginDownloadToFile(
String^ path,
FileMode mode,
AsyncCallback^ callback,
Object^ state
)
[<DoesServiceRequestAttribute>]
abstract BeginDownloadToFile :
path:string *
mode:FileMode *
callback:AsyncCallback *
state:Object -> ICancellableAsyncResult
[<DoesServiceRequestAttribute>]
override BeginDownloadToFile :
path:string *
mode:FileMode *
callback:AsyncCallback *
state:Object -> ICancellableAsyncResult
<DoesServiceRequestAttribute>
Public Overridable Function BeginDownloadToFile (
path As String,
mode As FileMode,
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.
- 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.ICancellableAsyncResultAn ICancellableAsyncResult that references the asynchronous operation.
Return to top
Begins an asynchronous operation to download the contents of a file in the File service to a local file.
Syntax
[DoesServiceRequestAttribute] public virtual ICancellableAsyncResult BeginDownloadToFile( string path, FileMode mode, AsyncCallback callback, object state )
C++
public: [DoesServiceRequestAttribute] virtual ICancellableAsyncResult^ BeginDownloadToFile( String^ path, FileMode mode, AsyncCallback^ callback, Object^ state )
[<DoesServiceRequestAttribute>] abstract BeginDownloadToFile : path:string * mode:FileMode * callback:AsyncCallback * state:Object -> ICancellableAsyncResult [<DoesServiceRequestAttribute>] override BeginDownloadToFile : path:string * mode:FileMode * callback:AsyncCallback * state:Object -> ICancellableAsyncResult
<DoesServiceRequestAttribute> Public Overridable Function BeginDownloadToFile ( path As String, mode As FileMode, 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.
- 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.ICancellableAsyncResultAn ICancellableAsyncResult that references the asynchronous operation.