Begins an asynchronous request to download a file from the FTP server and save it locally.
Namespace: EnterpriseDT.Net.FtpAssembly: edtFTPnetPRO (in edtFTPnetPRO.dll) Version: 9.4.0.40
Syntax
C# |
---|
public virtual IAsyncResult BeginDownloadFile( string localPath, string remoteFile, WriteMode writeMode, AsyncCallback callback, Object state ) |
Visual Basic |
---|
Public Overridable Function BeginDownloadFile ( _ localPath As String, _ remoteFile As String, _ writeMode As WriteMode, _ callback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
Visual C++ |
---|
public: virtual IAsyncResult^ BeginDownloadFile( String^ localPath, String^ remoteFile, WriteMode writeMode, AsyncCallback^ callback, Object^ state ) |
Parameters
- localPath
- Type: System..::..String
Local file to put data in.
- remoteFile
- Type: System..::..String
Name of remote file in current working directory.
- writeMode
- Type: EnterpriseDT.Net.Ftp..::..WriteMode
Overwrite, Append or Resume.
- callback
- Type: System..::..AsyncCallback
The AsyncCallback delegate.
- state
- Type: System..::..Object
An object that contains state information for this request.
Return Value
An FTPTask that references the asynchronous download.Remarks
You can create a callback method that implements the AsyncCallback delegate and pass its name to the BeginDownloadFile method. The state argument may be used to pass in data that will be passed to the callback method.
For more information please refer to the synchronous version of this method, DownloadFile(String, String).