'Declaration
 
Public Overloads Function BeginReceiveFile( _

   ByVal remoteFilename As String, _

   ByVal destination As Stream, _

   ByVal callback As AsyncCallback, _

   ByVal state As Object _

) As IAsyncResult

'Usage
 
Dim instance As AsyncFtpClient

Dim remoteFilename As String

Dim destination As Stream

Dim callback As AsyncCallback

Dim state As Object

Dim value As IAsyncResult

 

value = instance.BeginReceiveFile(remoteFilename, destination, callback, state)

public IAsyncResult BeginReceiveFile( 

   string remoteFilename,

   Stream destination,

   AsyncCallback callback,

   object state

)

Parameters

remoteFilename

The filename of the file to retrieve. Some FTP servers may be case-sensitive!

destination

A reference to the System.IO.Stream to which to receive the file.

callback

Callback method to be called when the asynchronous operation is completed.

state

An object containing state information for this operation.

Return Value

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.

The destination stream must be writable (System.IO.Stream.CanWrite) and must be closed by the user.

When using this overload of the BeginReceiveFile method, in the FtpClient.ReceivingFile event, the TransferringFileEventArgs.LocalFilename property will be System.String.Empty.

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.

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

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List