The following tables list the members exposed by FtpClient.
Public Constructors
Public Properties
| Name | Description |
| ActiveSecurityOptions | |
| Busy | Gets a boolean value indicating if the FTP client is currently performing an FTP operation. For detailed state information, consult the State property. |
| Connected | Gets a boolean value indicating if the FTP client is connected to an FTP server. For detailed state information, consult the State property. |
| DataChannelProtection | |
| DataTransferBufferSize | Gets or sets a value representing the size of the buffer used during data transfers. |
| Encoding | Gets 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. |
| FxpPassiveTransfer | Gets or sets a Boolean value indicating if FXP file transfers use the passive method or not to initiate the data connection. |
| HostName | Gets the host name used to connect, or an empty string if not connected. |
| KeepAliveInterval | Gets or sets the interval, in seconds, at which a NOOP command is sent on the command channel during a file transfer. |
| ListingMethod | Gets the current listing method that is used to retrieve folder contents from the FTP server. |
| ListingParsers | Gets a collection of FtpListingParser objects that are used to parse the lines returned by calls to various methods. |
| LocalAddress | Gets or sets the local IP address and port from which the FTP client is connected. |
| LocalDataAddress | Gets 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. |
| PassiveTransfer | Gets or sets a boolean value indicating if the FTP client should initiate the data connection rather than the FTP server. |
| PreAllocateStorage | Gets or sets a boolean value indicating if the FTP server must reserve enough space before a file is sent. |
| Proxy | Gets or sets the proxy client to use for connecting and/or logging in via a proxy server. |
| RepresentationType | Gets or sets a value indicating how the data is transferred to and from the FTP server. |
| SendTelnetInterruptSignal | Gets 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. |
| SendTypeCommand | Gets or sets a boolean value indicating if the TYPE command should be sent before initiating a file transfer. |
| ServerAddress | Gets the IP address and port to which the FTP client is connected. |
| ServerFolderSeparator | Gets or sets the FTP server's folder separator character. |
| State | Gets a value indicating the current state of the FTP client. |
| SynchronizingObject | Gets or sets the object used to automatically redirect events on the main UI thread. |
| Timeout | Gets or sets a value, in seconds, indicating after what period of time an FTP operation
should timeout. |
| TraceWriter | Gets 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. |
| TransferMode | Gets the transfer mode used to send and receive data to and from an FTP server. |
| UseRemoteAddress | Gets or sets a value indicating whether to use the remote address. |
Top
Public Methods
| Name | Description |
| Abort | Aborts the current FTP command. |
| Authenticate | Overloaded. Authenticates and encrypts the current FTP connection. |
| ChangeCurrentFolder | Changes the current working folder of the FTP server. |
| ChangeDataChannelProtection | Changes the data channel protection. |
| ChangeListingMethod | Changes the current listing method that is used to retrieve folder contents from the FTP server. |
| ChangeToParentFolder | Changes the current working folder of the FTP server to the parent folder. |
| ChangeTransferMode | Changes the current transfer mode. |
| ChangeUser | Overloaded. Changes the currently logged-in user to the anonymous user without disconnecting from the FTP server. |
| ClearCommandChannel | Clears the command channel after login to facilitate firewall NAT when connecting using a secure data channel. |
| Connect | Overloaded. Connects the FTP client to an FTP server on port 21. |
| CreateFolder | Create a folder on the FTP server. |
| DeleteFile | Deletes a file from the FTP server. |
| DeleteFolder | Overloaded. Deletes a folder from the FTP server. |
| Disconnect | Disconnects the FTP client from the FTP server to which it is connected. |
| FxpCopy | 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. |
| GetCurrentFolder | Retrieves the current working folder of the FTP server. |
| GetDownloadStream | Overloaded. Retrieves a direct access to the readonly data stream being received. |
| GetFolderContents | Overloaded. Retrieves the contents of the current working folder. |
| GetRawExtendedFeatures | Retrieves an unprocessed, clear text list of the extended features that are implemented by an FTP server. |
| GetRawFolderContents | Overloaded. 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. |
| GetUploadStream | Overloaded. Retrieves a direct access to the write-only data stream to send to. |
| Login | Overloaded. Login the FTP client anonymously to the FTP server to which it is connected. |
| ReceiveFile | Overloaded. Receives the specified file from the current working folder and stores it on the local system using the specified path and filename. |
| ReceiveMultipleFiles | Receives the files that match the provided file mask from the current working folder and stores them on the local system in the specified folder. |
| RenameFile | Renames a file or, if supported, a folder on the FTP server. |
| SendCustomCommand | Sends a custom command to the FTP server. |
| SendFile | Overloaded. Sends the specified file to the FTP server's current working folder and stores it using the same filename. |
| SendFileToUniqueName | Overloaded. Sends the specified file to the FTP server's current working folder and stores it using a unique filename. |
| SendMultipleFiles | Sends the files that match the provided file mask to the FTP server's current working folder. |
Top
Public Events
| Name | Description |
| CertificateReceived | Raised when an FTP server's certificate was received and verified. |
| CertificateRequired | Raised 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. |
| CommandSent | Raised once for every command sent to the FTP server. |
| Disconnected | Raised when the Disconnect method is called as well as when the connection is terminated by the FTP server. |
| FileTransferStatus | Raised for every 4Kb sent or received during a file transfer. |
| MultipleFileTransferError | Raised when an error occurs while transferring multiple files to or from the FTP server to determine what action should be taken. |
| ParsingListingLine | Raised when a listing line is received from the FTP server. |
| ReceivingFile | Raised for each file being received from the FTP server. |
| ReplyReceived | Raised once for each reply received from the FTP server. If a reply contains multiple
lines, they will be received as a group. |
| SendingFile | Raised for each file being sent to the FTP server. |
| StateChanged | Raised when the State of the FTP client changes. |
Top
See Also