Xceed .NET Libraries Documentation
ReceiveFile(String,Int64,String,Boolean) Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > FtpClient Class > ReceiveFile Method : ReceiveFile(String,Int64,String,Boolean) Method
The filename of the file to retrieve. Some FTP servers may be case-sensitive!
The byte offset (of the remote file) at which to start receiving data from the remote file. If append is true, the remote file will be appended to the end of the local file no matter what the value of offset. Therefore, to implement a real resume procedure, the size of the local file must be specified in offset and append must be set to true.
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.
Receives the specified file from the current working folder starting from the specified offset and stores it on the local system using the specified path and filename indicating if the file should append itself to the local file if it already exists.
Syntax
'Declaration
 
Public Overloads Sub ReceiveFile( _
   ByVal remoteFilename As String, _
   ByVal offset As Long, _
   ByVal localFilename As String, _
   ByVal append As Boolean _
) 
'Usage
 
Dim instance As FtpClient
Dim remoteFilename As String
Dim offset As Long
Dim localFilename As String
Dim append As Boolean
 
instance.ReceiveFile(remoteFilename, offset, localFilename, append)
public void ReceiveFile( 
   string remoteFilename,
   long offset,
   string localFilename,
   bool append
)

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. If append is true, the remote file will be appended to the end of the local file no matter what the value of offset. Therefore, to implement a real resume procedure, the size of the local file must be specified in offset and append must be set to true.
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.
Exceptions
ExceptionDescription
Cannot perform the requested operation because the FTP client is in an invalid state.
An error reply was returned by the FTP server.
An I/O error has occurred.
A fatal FTP-specific error has occurred..
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 ChangeCurrentFolder and/or ChangeToParentFolder 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 GetCurrentFolder method.

The ReceiveFile method will send the RETR, REST and PORT or PASV commands and optionally the TYPE command to the FTP server.

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

FtpClient Class
FtpClient Members
Overload List