'Declaration
 
Public Overloads Function BeginReceiveFile( _
   ByVal remoteFilename As String, _
   ByVal offset As Long, _
   ByVal destination As Stream, _
   ByVal callback As AsyncCallback, _
   ByVal state As Object _
) As IAsyncResult

'Usage
 
Dim instance As AsyncFtpClient
Dim remoteFilename As String
Dim offset As Long
Dim destination As Stream
Dim callback As AsyncCallback
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginReceiveFile(remoteFilename, offset, destination, callback, state)

public IAsyncResult BeginReceiveFile( 
   string remoteFilename,
   long offset,
   Stream destination,
   AsyncCallback callback,
   object state
)

Parameters

remoteFilename

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

offset

The byte offset (of the remote file) at which to start receiving data from the remote file.

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.

.NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

.NET Standard: netstandard2.0, netstandard2.1

.NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List
System.IO.Stream
EndReceiveFile Method
System.IO.Stream.CanWrite
ReceivingFile Event
LocalFilename Property
System.String.Empty
System.IAsyncResult
EndReceiveFile Method
System.IAsyncResult