Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class
Fields Properties Methods Events


In This Topic
    FtpClient Class Members
    In This Topic

    The following tables list the members exposed by FtpClient.

    Public Constructors
     NameDescription
    Public ConstructorFtpClient ConstructorInitializes a new instance of the FtpClient class.  
    Top
    Public Fields
     NameDescription
    Public FieldDefaultTraceWriterTimestampFormat  
    Public FieldDefaultTraceWriterTimestampFormatProvider  
    Public FieldDefaultTraceWriterTimestampUTC  
    Top
    Protected Fields
     NameDescription
    Protected Fieldm_rawExtendedFeatureCache  
    Top
    Public Properties
     NameDescription
    Public PropertyActiveSecurityOptions  
    Public PropertyBusyGets a boolean value indicating if the FTP client is currently performing an FTP operation. For detailed state information, consult the State property.  
    Public PropertyConnectedGets a boolean value indicating if the FTP client is connected to an FTP server. For detailed state information, consult the State property.  
    Public PropertyDataChannelProtection  
    Public Propertystatic (Shared in Visual Basic)DataTransferBufferSizeGets or sets a value representing the size of the buffer used during data transfers.  
    Public PropertyEncodingGets 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 PropertyFxpPassiveTransferGets or sets a Boolean value indicating if FXP file transfers use the passive method or not to initiate the data connection.  
    Public PropertyHostNameGets the host name used to connect, or an empty string if not connected.  
    Public PropertyKeepAliveIntervalGets or sets the interval, in seconds, at which a NOOP command is sent on the command channel during a file transfer.  
    Public PropertyListingMethodGets the current listing method that is used to retrieve folder contents from the FTP server.  
    Public PropertyListingParsersGets a collection of FtpListingParser objects that are used to parse the lines returned by calls to various methods.  
    Public PropertyLocalAddressGets or sets the local IP address and port from which the FTP client is connected.  
    Public PropertyLocalDataAddressGets 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 PropertyPassiveTransferGets or sets a boolean value indicating if the FTP client should initiate the data connection rather than the FTP server.  
    Public PropertyPreAllocateStorageGets or sets a boolean value indicating if the FTP server must reserve enough space before a file is sent.  
    Public PropertyProxyGets or sets the proxy client to use for connecting and/or logging in via a proxy server.  
    Public PropertyRepresentationTypeGets or sets a value indicating how the data is transferred to and from the FTP server.  
    Public PropertySendTelnetInterruptSignalGets 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 PropertySendTypeCommandGets or sets a boolean value indicating if the TYPE command should be sent before initiating a file transfer.  
    Public PropertyServerAddressGets the IP address and port to which the FTP client is connected.  
    Public PropertyServerFolderSeparatorGets or sets the FTP server's folder separator character.  
    Public PropertyStateGets a value indicating the current state of the FTP client.  
    Public PropertySynchronizingObjectGets or sets the object used to automatically redirect events on the main UI thread.  
    Public PropertyTimeoutGets or sets a value, in seconds, indicating after what period of time an FTP operation should timeout.  
    Public PropertyTraceWriterGets 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 PropertyTraceWriterTimestampFormat  
    Public PropertyTraceWriterTimestampFormatProvider  
    Public PropertyTraceWriterTimestampUTC  
    Public PropertyTransferModeGets the transfer mode used to send and receive data to and from an FTP server.  
    Public PropertyUseRemoteAddressGets or sets a value indicating whether to use the remote address.  
    Top
    Public Methods
     NameDescription
    Public MethodAbortAborts the current FTP command.  
    Public MethodAuthenticateOverloaded. Authenticates and encrypts the current FTP connection.  
    Public MethodChangeCurrentFolderChanges the current working folder of the FTP server.  
    Public MethodChangeDataChannelProtectionChanges the data channel protection.  
    Public MethodChangeListingMethodChanges the current listing method that is used to retrieve folder contents from the FTP server.  
    Public MethodChangeToParentFolderChanges the current working folder of the FTP server to the parent folder.  
    Public MethodChangeTransferModeChanges the current transfer mode.  
    Public MethodChangeUserOverloaded. Changes the currently logged-in user to the anonymous user without disconnecting from the FTP server.  
    Public MethodClearCommandChannelClears the command channel after login to facilitate firewall NAT when connecting using a secure data channel.  
    Public MethodConnectOverloaded. Connects the FTP client to an FTP server on port 21.  
    Public MethodCreateFolderCreate a folder on the FTP server.  
    Public MethodDeleteFileDeletes a file from the FTP server.  
    Public MethodDeleteFolderOverloaded. Deletes a folder from the FTP server.  
    Public MethodDisconnectDisconnects the FTP client from the FTP server to which it is connected.  
    Public Methodstatic (Shared in Visual Basic)FxpCopyOverloaded. 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 MethodGetCurrentFolderRetrieves the current working folder of the FTP server.  
    Public MethodGetDownloadStreamOverloaded. Retrieves a direct access to the readonly data stream being received.  
    Public MethodGetFolderContentsOverloaded. Retrieves the contents of the current working folder.  
    Public MethodGetRawExtendedFeaturesRetrieves an unprocessed, clear text list of the extended features that are implemented by an FTP server.  
    Public MethodGetRawFolderContentsOverloaded. 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 MethodGetUploadStreamOverloaded. Retrieves a direct access to the write-only data stream to send to.  
    Public MethodLoginOverloaded. Login the FTP client anonymously to the FTP server to which it is connected.  
    Public MethodReceiveFileOverloaded. Receives the specified file from the current working folder and stores it on the local system using the specified path and filename.  
    Public MethodReceiveMultipleFilesReceives 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 MethodRenameFileRenames a file or, if supported, a folder on the FTP server.  
    Public MethodSendCustomCommandSends a custom command to the FTP server.  
    Public MethodSendFileOverloaded. Sends the specified file to the FTP server's current working folder and stores it using the same filename.  
    Public MethodSendFileToUniqueNameOverloaded. Sends the specified file to the FTP server's current working folder and stores it using a unique filename.  
    Public MethodSendMultipleFilesSends the files that match the provided file mask to the FTP server's current working folder.  
    Top
    Public Events
     NameDescription
    Public EventCertificateReceivedRaised when an FTP server's certificate was received and verified.  
    Public EventCertificateRequiredRaised 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 EventCommandSentRaised once for every command sent to the FTP server.  
    Public EventDisconnectedRaised when the Disconnect method is called as well as when the connection is terminated by the FTP server.  
    Public EventFileTransferStatusRaised for every 4Kb sent or received during a file transfer.  
    Public EventMultipleFileTransferErrorRaised when an error occurs while transferring multiple files to or from the FTP server to determine what action should be taken.  
    Public EventParsingListingLineRaised when a listing line is received from the FTP server.  
    Public EventReceivingFileRaised for each file being received from the FTP server.  
    Public EventReplyReceivedRaised once for each reply received from the FTP server. If a reply contains multiple lines, they will be received as a group.  
    Public EventSendingFileRaised for each file being sent to the FTP server.  
    Public EventStateChangedRaised when the State of the FTP client changes.  
    Top
    See Also

    Reference

    FtpClient Class
    Xceed.Ftp Namespace

    Send Feedback