Gets a listing of the provided remote folder, specifying a port, a username/password, an authentication method, whether authentication is implicit, verification flags, a certificate, data channel protection, a proxy, a time-out, default representation type, whether files are listed recursively and/or passively, a trace writer, a synchronizing object, delegates for notifications, and filters.
Syntax
'Declaration
Public Overloads Shared Function GetFtpContents( _
ByVal As String, _
ByVal As Integer, _
ByVal As String, _
ByVal As String, _
ByVal As AuthenticationMethod, _
ByVal As VerificationFlags, _
ByVal As Certificate, _
ByVal As DataChannelProtection, _
ByVal As Boolean, _
ByVal As ProxyClient, _
ByVal As Integer, _
ByVal As Boolean, _
ByVal As RepresentationType, _
ByVal As TextWriter, _
ByVal As String, _
ByVal As Boolean, _
ByVal As ISynchronizeInvoke, _
ByVal As QuickFtp.CertificateReceivedCallback, _
ByVal As QuickFtp.CertificateRequiredCallback, _
ByVal ParamArray () As String _
) As QuickFtpItem()
'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 proxy As ProxyClient
Dim timeout As Integer
Dim passiveTransfer As Boolean
Dim defaultRepresentationType As RepresentationType
Dim traceWriter As TextWriter
Dim remoteFolderToList As String
Dim recursive As Boolean
Dim synchronizingObject As ISynchronizeInvoke
Dim certificateReceivedCallback As QuickFtp.CertificateReceivedCallback
Dim certificateRequiredCallback As QuickFtp.CertificateRequiredCallback
Dim filters() As String
Dim value() As QuickFtpItem
value = QuickFtp.GetFtpContents(hostname, port, username, password, authenticationMethod, verificationFlags, clientCertificate, dataChannelProtection, implicitAuthentication, proxy, timeout, passiveTransfer, defaultRepresentationType, traceWriter, remoteFolderToList, recursive, synchronizingObject, certificateReceivedCallback, certificateRequiredCallback, filters)
public static QuickFtpItem[] GetFtpContents(
string ,
int ,
string ,
string ,
AuthenticationMethod ,
VerificationFlags ,
Certificate ,
DataChannelProtection ,
bool ,
ProxyClient ,
int ,
bool ,
RepresentationType ,
TextWriter ,
string ,
bool ,
ISynchronizeInvoke ,
QuickFtp.CertificateReceivedCallback ,
QuickFtp.CertificateRequiredCallback ,
params string[]
)
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.
- 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.
- proxy
- The active proxy client for connecting to the FTP server.
- timeout
- 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.
- remoteFolderToList
- The path to the remote folder to list. i.e.: \ftproot\test
- recursive
- Boolean value indicating if files contained within sub-folders should be got from the ftp host
- 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.
- filters
- The filters to apply for the GetFtpContents.
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