Xceed .NET Libraries Documentation
BeginReceiveFile(String,String,Boolean,AsyncCallback,Object) Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class > BeginReceiveFile Method : BeginReceiveFile(String,String,Boolean,AsyncCallback,Object) Method
The filename of the file to retrieve. Some FTP servers may be case-sensitive!
The path and filename of the file as it will be stored on the local system.
true if the file should append itself to the local file if it already exists; false if the local file should be overwritten.
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.
Begins the process of receiving the specified file from the current working folder and stores it on the local system using the specified path and filename and indicates if the file should append itself to the local file if it already exists. Don't forget to call EndReceiveFile!
Syntax
'Declaration
 
Public Overloads Function BeginReceiveFile( _

   ByVal remoteFilename As String, _

   ByVal localFilename As String, _

   ByVal append As Boolean, _

   ByVal callback As AsyncCallback, _

   ByVal state As Object _

) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient

Dim remoteFilename As String

Dim localFilename As String

Dim append As Boolean

Dim callback As AsyncCallback

Dim state As Object

Dim value As IAsyncResult

 

value = instance.BeginReceiveFile(remoteFilename, localFilename, append, callback, state)
public IAsyncResult BeginReceiveFile( 

   string remoteFilename,

   string localFilename,

   bool append,

   AsyncCallback callback,

   object state

)

Parameters

remoteFilename
The filename of the file to retrieve. Some FTP servers may be case-sensitive!
localFilename
The path and filename of the file as it will be stored on the local system.
append
true if the file should append itself to the local file if it already exists; false if the local file should be overwritten.
callback
Callback method to be called when the asynchronous operation is completed.
state
An object containing state information for this operation.

Return Value

An System.IAsyncResult representing the status of the asynchronous operation.
Remarks

By default, the file will be received from the current working folder. If you want to receive the file from another location, you could use the BeginChangeCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeCurrentFolder(System.IAsyncResult)% methods and/or BeginChangeToParentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeToParentFolder(System.IAsyncResult)% methods to change the current working folder. Absolute paths can also be provided, however some FTP servers might not support absolute paths and different server types may have different ways of representing absolute paths.

The current working folder can be retrieved via the BeginGetCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndGetCurrentFolder(System.IAsyncResult)% methods.

When using a callback, the System.IAsyncResult is provided as a parameter. You should call EndReceiveFile in that callback. When NOT providing a callback, you should keep the returned IAsyncResult and call EndReceiveFile with it when ready to complete. In this later case, the call to EndReceiveFile may block until the operation completes.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List