Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / ReceiveFile Method / ReceiveFile(String,String,Boolean) 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.


In This Topic
    ReceiveFile(String,String,Boolean) Method
    In This Topic
    Receives 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.
    Syntax
    'Declaration
     
    
    Public Overloads Sub ReceiveFile( _
       ByVal remoteFilename As String, _
       ByVal localFilename As String, _
       ByVal append As Boolean _
    ) 
    'Usage
     
    
    Dim instance As FtpClient
    Dim remoteFilename As String
    Dim localFilename As String
    Dim append As Boolean
     
    instance.ReceiveFile(remoteFilename, localFilename, append)
    public void ReceiveFile( 
       string remoteFilename,
       string localFilename,
       bool append
    )

    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.
    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 and PORT or PASV commands and optionally the TYPE command to the FTP server.

    Supported Frameworks

    .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.

    See Also