Xceed .NET Libraries Documentation
ReceiveFile(String,Stream) Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > FtpClient Class > ReceiveFile Method : ReceiveFile(String,Stream) Method
The filename of the file to retrieve. Some FTP servers may be case-sensitive!
A reference to the System.IO.Stream to which to receive the file.
Receives the specified file from the current working folder to the specified System.IO.Stream.
Syntax
'Declaration
 
Public Overloads Sub ReceiveFile( _
   ByVal remoteFilename As String, _
   ByVal destination As Stream _
) 
'Usage
 
Dim instance As FtpClient
Dim remoteFilename As String
Dim destination As Stream
 
instance.ReceiveFile(remoteFilename, destination)
public void ReceiveFile( 
   string remoteFilename,
   Stream destination
)

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.
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 destination stream must be writable (System.IO.Stream.CanWrite) and must be closed by the user.

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

The ReceiveFile method will send the RETR 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