Xceed .NET Libraries Documentation
FtpClient Class Members
Fields  Properties  Methods  Events


Xceed.Ftp Assembly > Xceed.Ftp Namespace : FtpClient Class

The following tables list the members exposed by FtpClient.

Public Constructors
 NameDescription
Public ConstructorInitializes a new instance of the FtpClient class.  
Top
Protected Fields
 NameDescription
Protected Field  
Top
Public Properties
 NameDescription
Public Property  
Public PropertyGets a boolean value indicating if the FTP client is currently performing an FTP operation. For detailed state information, consult the State property.  
Public PropertyGets a boolean value indicating if the FTP client is connected to an FTP server. For detailed state information, consult the State property.  
Public Property  
Public Propertystatic (Shared in Visual Basic)Gets or sets a value representing the size of the buffer used during data transfers.  
Public PropertyGets or sets the System.Text.Encoding that is used to encode commands sent to the server, and decode replies and folder listings received from the server.  
Public PropertyGets or sets a Boolean value indicating if FXP file transfers use the passive method or not to initiate the data connection.  
Public PropertyGets the host name used to connect, or an empty string if not connected.  
Public PropertyGets or sets the interval, in seconds, at which a NOOP command is sent on the command channel during a file transfer.  
Public PropertyGets the current listing method that is used to retrieve folder contents from the FTP server.  
Public PropertyGets a collection of FtpListingParser objects that are used to parse the lines returned by calls to various methods.  
Public PropertyGets or sets the local IP address and port from which the FTP client is connected.  
Public PropertyGets or sets the IP address and port of the client-side data connection to use in subsequent data connections. If PassiveTransfer is false, this property represents the address of the client-side listening socket waiting for the server’s data connection request.  
Public PropertyGets or sets a boolean value indicating if the FTP client should initiate the data connection rather than the FTP server.  
Public PropertyGets or sets a boolean value indicating if the FTP server must reserve enough space before a file is sent.  
Public PropertyGets or sets the proxy client to use for connecting and/or logging in via a proxy server.  
Public PropertyGets or sets a value indicating how the data is transferred to and from the FTP server.  
Public PropertyGets or sets a value indicating if the Telnet interrupt signal should be sent before the QUIT command is sent to an FTP server, allowing an FTP server to be notified that the connection will be terminated. This property does not apply to the Compact Framework.  
Public PropertyGets or sets a boolean value indicating if the TYPE command should be sent before initiating a file transfer.  
Public PropertyGets the IP address and port to which the FTP client is connected.  
Public PropertyGets or sets the FTP server's folder separator character.  
Public PropertyGets a value indicating the current state of the FTP client.  
Public PropertyGets or sets the object used to automatically redirect events on the main UI thread.  
Public PropertyGets or sets a value, in seconds, indicating after what period of time an FTP operation should timeout.  
Public PropertyGets or sets the System.IO.TextWriter which will trace the connection/deconnection process as well as the commands and replies sent to and received from the FTP server.  
Public PropertyGets the transfer mode used to send and receive data to and from an FTP server.  
Public PropertyGets or sets a value indicating whether to use the remote address.  
Top
Public Methods
 NameDescription
Public MethodAborts the current FTP command.  
Public MethodOverloaded. Authenticates and encrypts the current FTP connection.  
Public MethodChanges the current working folder of the FTP server.  
Public MethodChanges the data channel protection.  
Public MethodChanges the current listing method that is used to retrieve folder contents from the FTP server.  
Public MethodChanges the current working folder of the FTP server to the parent folder.  
Public MethodChanges the current transfer mode.  
Public MethodOverloaded. Changes the currently logged-in user to the anonymous user without disconnecting from the FTP server.  
Public MethodClears the command channel after login to facilitate firewall NAT when connecting using a secure data channel.  
Public MethodOverloaded. Connects the FTP client to an FTP server on port 21.  
Public MethodCreate a folder on the FTP server.  
Public MethodDeletes a file from the FTP server.  
Public MethodOverloaded. Deletes a folder from the FTP server.  
Public MethodDisconnects the FTP client from the FTP server to which it is connected.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Directs two specified FTP clients to perform a FXP (server to server) file transfer from the specified source FTP server to the specified destination FTP server.  
Public MethodRetrieves the current working folder of the FTP server.  
Public MethodOverloaded. Retrieves a direct access to the readonly data stream being received.  
Public MethodOverloaded. Retrieves the contents of the current working folder.  
Public MethodRetrieves an unprocessed, clear text list of the extended features that are implemented by an FTP server.  
Public MethodOverloaded. Retrieves an unprocessed, clear text list representing the contents of the current working folder as sent by the FTP server and indicates if the entire listing or only filenames should be retrieved.  
Public MethodOverloaded. Retrieves a direct access to the write-only data stream to send to.  
Public MethodOverloaded. Login the FTP client anonymously to the FTP server to which it is connected.  
Public MethodOverloaded. Receives the specified file from the current working folder and stores it on the local system using the specified path and filename.  
Public MethodReceives the files that match the provided file mask from the current working folder and stores them on the local system in the specified folder.  
Public MethodRenames a file or, if supported, a folder on the FTP server.  
Public MethodSends a custom command to the FTP server.  
Public MethodOverloaded. Sends the specified file to the FTP server's current working folder and stores it using the same filename.  
Public MethodOverloaded. Sends the specified file to the FTP server's current working folder and stores it using a unique filename.  
Public MethodSends the files that match the provided file mask to the FTP server's current working folder.  
Top
Public Events
 NameDescription
Public EventRaised when an FTP server's certificate was received and verified.  
Public EventRaised when a client certificate is required by the FTP server, or the one provided (if e.Certificate is not a null reference (Nothing in Visual Basic)) was rejected. Note: This event is not available in Xceed FTP for .NET Compact Framework because this product does not support Secure FTP.  
Public EventRaised once for every command sent to the FTP server.  
Public EventRaised when the Disconnect method is called as well as when the connection is terminated by the FTP server.  
Public EventRaised for every 4Kb sent or received during a file transfer.  
Public EventRaised when an error occurs while transferring multiple files to or from the FTP server to determine what action should be taken.  
Public EventRaised when a listing line is received from the FTP server.  
Public EventRaised for each file being received from the FTP server.  
Public EventRaised once for each reply received from the FTP server. If a reply contains multiple lines, they will be received as a group.  
Public EventRaised for each file being sent to the FTP server.  
Public EventRaised when the State of the FTP client changes.  
Top
See Also

Reference

FtpClient Class
Xceed.Ftp Namespace