Receive(String,Int32,String,String,AuthenticationMethod,VerificationFlags,Certificate,DataChannelProtection,Boolean,String,Boolean,Boolean,Boolean,ProxyClient,Int32,Boolean,RepresentationType,TextWriter,ISynchronizeInvoke,CertificateReceivedCallback,CertificateRequiredCallback,ByteProgressionCallback,ItemProgressionCallback,Object,TransferMode,String[]) Method

Receives a list of files from an FTP server to a local folder, specifying a port, a username and password, an authentication method, whether authentication is implicit, verification flags, a certificate, whether existing files will be replaced, directory structure will be preserved, transfer will be passive and/or recursive, a proxy, a time-out, transfer mode, default representation type, delegates for notifications, etc.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Sub Receive( _

   ByVal hostname As String, _

   ByVal port As Integer, _

   ByVal username As String, _

   ByVal password As String, _

   ByVal authenticationMethod As AuthenticationMethod, _

   ByVal verificationFlags As VerificationFlags, _

   ByVal clientCertificate As Certificate, _

   ByVal dataChannelProtection As DataChannelProtection, _

   ByVal implicitAuthentication As Boolean, _

   ByVal localDestinationFolder As String, _

   ByVal replaceExistingFiles As Boolean, _

   ByVal recursive As Boolean, _

   ByVal preservePaths As Boolean, _

   ByVal proxy As ProxyClient, _

   ByVal timeout As Integer, _

   ByVal passiveTransfer As Boolean, _

   ByVal defaultRepresentationType As RepresentationType, _

   ByVal traceWriter As TextWriter, _

   ByVal synchronizingObject As ISynchronizeInvoke, _

   ByVal certificateReceivedCallback As QuickFtp.CertificateReceivedCallback, _

   ByVal certificateRequiredCallback As QuickFtp.CertificateRequiredCallback, _

   ByVal byteProgressionCallback As QuickFtp.ByteProgressionCallback, _

   ByVal itemProgressionCallback As QuickFtp.ItemProgressionCallback, _

   ByVal userParams As Object, _

   ByVal transferMode As TransferMode, _

   ByVal ParamArray filesToReceive() As String _

)

'Usage
 
Dim hostname As String

Dim port As Integer

Dim username As String

Dim password As String

Dim authenticationMethod As AuthenticationMethod

Dim verificationFlags As VerificationFlags

Dim clientCertificate As Certificate

Dim dataChannelProtection As DataChannelProtection

Dim implicitAuthentication As Boolean

Dim localDestinationFolder As String

Dim replaceExistingFiles As Boolean

Dim recursive As Boolean

Dim preservePaths As Boolean

Dim proxy As ProxyClient

Dim timeout As Integer

Dim passiveTransfer As Boolean

Dim defaultRepresentationType As RepresentationType

Dim traceWriter As TextWriter

Dim synchronizingObject As ISynchronizeInvoke

Dim certificateReceivedCallback As QuickFtp.CertificateReceivedCallback

Dim certificateRequiredCallback As QuickFtp.CertificateRequiredCallback

Dim byteProgressionCallback As QuickFtp.ByteProgressionCallback

Dim itemProgressionCallback As QuickFtp.ItemProgressionCallback

Dim userParams As Object

Dim transferMode As TransferMode

Dim filesToReceive() As String

 

QuickFtp.Receive(hostname, port, username, password, authenticationMethod, verificationFlags, clientCertificate, dataChannelProtection, implicitAuthentication, localDestinationFolder, replaceExistingFiles, recursive, preservePaths, proxy, timeout, passiveTransfer, defaultRepresentationType, traceWriter, synchronizingObject, certificateReceivedCallback, certificateRequiredCallback, byteProgressionCallback, itemProgressionCallback, userParams, transferMode, filesToReceive)

public static void Receive( 

   string hostname,

   int port,

   string username,

   string password,

   AuthenticationMethod authenticationMethod,

   VerificationFlags verificationFlags,

   Certificate clientCertificate,

   DataChannelProtection dataChannelProtection,

   bool implicitAuthentication,

   string localDestinationFolder,

   bool replaceExistingFiles,

   bool recursive,

   bool preservePaths,

   ProxyClient proxy,

   int timeout,

   bool passiveTransfer,

   RepresentationType defaultRepresentationType,

   TextWriter traceWriter,

   ISynchronizeInvoke synchronizingObject,

   QuickFtp.CertificateReceivedCallback certificateReceivedCallback,

   QuickFtp.CertificateRequiredCallback certificateRequiredCallback,

   QuickFtp.ByteProgressionCallback byteProgressionCallback,

   QuickFtp.ItemProgressionCallback itemProgressionCallback,

   object userParams,

   TransferMode transferMode,

   params string[] filesToReceive

)

Parameters

hostname: The hostname of the FTP server to connect to. An IP address can also be used.
port: The port of the FTP server to which to connect to. If 0 is passed, 990 is used if implicitAuthentication is true; otherwise, 21 is used (not applicable to the Compact Framework version).
username: The username used to connect to the FTP server.
password: The password used to connect to the FTP server.
authenticationMethod: The authentication method to use when connecting to the FTP server. Not applicable to the Compact Framework version.
verificationFlags: The verification flags used to verify the FTP server's certificate. Not applicable to the Compact Framework version.
clientCertificate: The certificate used when connecting to the FTP server. Can be null. Not applicable to the Compact Framework version.
dataChannelProtection: The DataChannelProtection used during the communication. Ignored if implicitAuthentication is true. Not applicable to the Compact Framework version.
implicitAuthentication: If true, the SSL handshake occurs at the very beginning of the connection; otherwise, the AUTH command is sent after the Welcome message to initiate the SSL handshake. Not applicable to the Compact Framework version.
localDestinationFolder: The local destination folder into which the files will be placed.
replaceExistingFiles: true if existing items in the destination should be replaced; false otherwise.
recursive: Boolean value indicating if files contained within sub-folders should be gotten from the ftp host.
preservePaths: Boolean value indicating if the directory structure should be preserved in the destination folder.
proxy: The active proxy client for connecting to the FTP server.
timeout: The period of time, in seconds, after which an FTP operation should timeout.
passiveTransfer: Boolean value indicating whether the data connection should be established by the FTP server rather than by the client-side.
defaultRepresentationType: The default value indicating how the data is transferred to and from the FTP server.
traceWriter: The System.IO.TextWriter which will trace the communications between the client-side and the FTP server.
synchronizingObject: The object used to automatically redirect events on the main UI thread. Not applicable to the Compact Framework version.
certificateReceivedCallback: Delegate for CertificateReceived notification. Not applicable to the Compact Framework version.
certificateRequiredCallback: Delegate for CertificateRequired notification. Not applicable to the Compact Framework version.
byteProgressionCallback: Delegate for ByteProgression notification.
itemProgressionCallback: Delegate for ItemProgression notification.
userParams: Opaque data that will be passed back to the event handler when an event is raised.
transferMode: The transfer mode used to send data to and from an FTP server.
filesToReceive: A list of strings representing the files to be gotten. File paths may not start with a \ or a /. If a path represents a folder, it must end with a / or a \.

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

Reference

QuickFtp Class
QuickFtp Members
Overload List