An NDoc Documented Class Library

ExFTPConnection Methods

The methods of the ExFTPConnection class are listed below. For a complete list of ExFTPConnection class members, see the ExFTPConnection Members topic.

Public Instance Methods

CancelResume (inherited from FTPConnection)Cancel the resume.
CancelTransferCancels the current transfer.
ChangeWorkingDirectory Changes the working directory.
ChangeWorkingDirectoryUp Changes to the parent of the current working directory on the server.
ClearDirectoryCacheOverloaded. Clears the directory cache completely.
Close (inherited from FTPConnection)Overloaded. Close the FTP connection.
ConnectConnect to the FTP server and (if AutoLogin is set) log into the server.
CreateDirectoryCreate the specified remote directory.
CreateObjRef (inherited from MarshalByRefObject) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
DeleteDirectoryDelete the specified remote directory.
DeleteDirectoryTree Delete this entire remote directory and its contents recursively, including all subdirectories.
DeleteFileDelete the specified remote file.
DeleteMultipleFilesOverloaded. Delete all the files in the supplied remote directory (and optionally its subdirectories) that match the supplied filter.
DirectoryExists Tests if the given directory exists.
Dispose (inherited from Component)Overloaded. Releases all resources used by the Component.
DownloadByteArrayDownload data from the FTP server and return it as a byte-array.
DownloadDirectory Downloads the remote directory (and its subdirectories) to the local directory.
DownloadFileOverloaded. Download a file from the FTP server and save it locally.
DownloadMultipleOverloaded. Get multiple files into the specified local directory from the current remote directory
DownloadStreamDownload a file from the FTP server and write it to the given stream.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
Exists Checks for the existence of a file on the server.
GetCommandHelpGet the help text for the specified FTP command.
GetFeaturesGet the server supplied features.
GetFileInfosOverloaded. Returns the given directory's contents as an array of FTPFile objects.
GetFilesOverloaded. List the given directory's contents as an array of strings of file-names or full file details.
GetHashCode (inherited from FTPConnection) Returns hash-code for this connection.
GetLastWriteTimeGet modification time for a remote file.
GetLifetimeService (inherited from MarshalByRefObject) Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetSize Get the size of a remote file.
GetSystemTypeGet the type of the operating system at the server.
GetType (inherited from Object) Gets the Type of the current instance.
GetURL (inherited from FTPConnection)Overloaded. Returns a URL corresponding to the current state of this SecureFTPConnection. The URL optionally includes the directory, user-name and password.
GetWorkingDirectoryObsolete. Returns the working directory on the server.
InitializeLifetimeService (inherited from MarshalByRefObject) Obtains a lifetime service object to control the lifetime policy for this instance.
InvokeFTPCommand Invokes the given literal FTP command on the server.
InvokeSiteCommand Invokes the given site command on the server.
LoginLog into an account on the FTP server using UserName and Password.
PostLogin Called after the user has been successfully logged in.
RenameFileRename a file or directory.
ResumeTransferMake the next file transfer (upload or download) resume.
SendAccountInfo (inherited from FTPConnection) Supply account info to the FTP server.
SendPassword Supply the password for the previously supplied user-name to log into the FTP server. Must be preceeded by the SendUserName method
SendUserName Supply the user-name to log into an account on the FTP server. Must be followed by the SendPassword method.
SetLastWriteTime (inherited from FTPConnection)Set modification time for a remote file.
SynchronizeOverloaded. Synchronizes LocalDirectory on the local machine with ServerDirectory according to the synchronization rules in DefaultSyncRules.
ToString (inherited from Component) 
TransferFileFXP Transfer a file between FTP servers using FXP.
Unlock Unlock the software for use. This method should be used when a configuration file isn't available
UploadByteArrayOverloaded. Upload data to the FTP server in the current working directory. Allows appending if current file exists.
UploadDirectory Uploads the local directory (and its subdirectories) to the remote directory.
UploadFileOverloaded. Upload a local file to the FTP server in the current working directory. Allows appending if current file exists.
UploadFile (inherited from FTPConnection)Overloaded. Upload a local file to the FTP server in the current working directory. Allows appending if current file exists.
UploadMultipleOverloaded. Put multiple files from the specified local directory into the specified remote directory.
UploadStreamOverloaded. Upload a stream of data to the FTP server in the current working directory. Allows appending if current file exists.

Protected Instance Methods

CheckFTPType (inherited from FTPConnection) Checks the FTP type and throws an exception if it's incorrect.
DisposeOverloaded. Close the connection if it is open.
Finalize (inherited from Component) Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetService (inherited from Component) Returns an object that represents a service provided by the Component or by its Container.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
OnBytesTransferred (inherited from FTPConnection) Called every time a specified number of bytes of data have been transferred.
OnChangedLocalDirectory (inherited from FTPConnection) Called when the local directory has been changed.
OnChangedServerDirectory (inherited from FTPConnection) Called when the server directory has been changed.
OnChangingLocalDirectory (inherited from FTPConnection) Called when the local directory is about to be changed.
OnChangingServerDirectory (inherited from FTPConnection) Called when the server directory is about to be changed.
OnClosed (inherited from FTPConnection) Called when a connection has closed.
OnClosing Stop the keep-alive thread then call base.
OnConnected Call base then start the keep-alive thread.
OnConnecting (inherited from FTPConnection) Called when a connection-attempt is being made.
OnCreatedDirectory (inherited from FTPConnection) Called when a directory has been created.
OnCreatingDirectory (inherited from FTPConnection) Called when a directory is about to be created.
OnDeleted (inherited from FTPConnection) Called when a file deletion operation has completed (though it may have been cancelled).
OnDeletedDirectory (inherited from FTPConnection) Called when a directory has been deleted.
OnDeleting (inherited from FTPConnection) Called when a file is about to be deleted.
OnDeletingDirectory (inherited from FTPConnection) Called when a directory is about to be deleted.
OnDirectoryListed (inherited from FTPConnection) Called when a directory listing has been retrieved.
OnDirectoryListing (inherited from FTPConnection) Called when a directory listing is about to be retrieved.
OnDownloaded (inherited from FTPConnection)Overloaded. Called when a file downloading operation has completed (though it may have been cancelled).
OnDownloading (inherited from FTPConnection)Overloaded. Called when a file is about to be downloaded.
OnLoggedIn (inherited from FTPConnection) Called when the client has logged in.
OnLoggingIn (inherited from FTPConnection) Called when the client is about to log in.
OnPropertyChanged Called when a property has been changed.
OnProxySettingsChanged Called when one of the properties of ProxySettings has changed.
OnRenamed (inherited from FTPConnection) Called when a file has been renamed.
OnRenaming (inherited from FTPConnection) Called when a file is about to be renamed.
OnUploaded (inherited from FTPConnection)Overloaded. Called when a file uploading operation has completed (though it may have been cancelled).
OnUploading (inherited from FTPConnection)Overloaded. Called when a file is about to be uploaded.
PerformAutoLoginAttempt to log into the server if AutoLogin is on.
RelativePathToAbsolute (inherited from FTPConnection) Combines a relative path with an absolute path.
SyncDownloadFileOverloaded. INTERNAL USE ONLY
SyncDownloadMultipleOverloaded. INTERNAL USE ONLY
SyncUploadFile INTERNAL USE ONLY.
SyncUploadMultipleOverloaded. INTERNAL USE ONLY.
TestConnection Test if the connection is still alive. If not then call Close so that events occur as they should.

Protected Internal Instance Methods

CheckConnection (inherited from FTPConnection) Checks if the client has connected to the server and throws an exception if it hasn't. This is only intended to be used by subclasses
ftpClient_BytesTransferred (inherited from FTPConnection) Event-handler for BytesTransferred events received from IFileTransferClients.
ftpClient_CommandSent (inherited from FTPConnection) Event-handler for CommandSent events received from IFileTransferClients.
ftpClient_ReplyReceived Remember the time so that we don't send keep-alives unnecessarily.
OnSynchronized Called after synchronization ends.
OnSynchronizing Called before synchronization begins.
OnSynchronizingFile Called when a file is about to be synchronized.
RaiseBytesTransferred (inherited from FTPConnection)Raise the BytesTransferred event.
RaiseClosed (inherited from FTPConnection)Raise the Closed event.
RaiseClosing (inherited from FTPConnection)Raise the Closing event.
RaiseCommandSent (inherited from FTPConnection)Raise the CommandSent event.
RaiseConnected (inherited from FTPConnection)Raise the Connected event.
RaiseConnecting (inherited from FTPConnection)Raise the Connecting event.
RaiseCreatedDirectory (inherited from FTPConnection)Raise the CreatedDirectory event.
RaiseCreatingDirectory (inherited from FTPConnection)Raise the CreatingDirectory event.
RaiseDeleted (inherited from FTPConnection)Raise the Deleted event.
RaiseDeletedDirectory (inherited from FTPConnection)Raise the DeletedDirectory event.
RaiseDeleting (inherited from FTPConnection)Raise the Deleting event.
RaiseDeletingDirectory (inherited from FTPConnection)Raise the DeletingDirectory event.
RaiseDirectoryChanged (inherited from FTPConnection)Raise the DirectoryChanged event.
RaiseDirectoryChanging (inherited from FTPConnection)Raise the DirectoryChanging event.
RaiseDirectoryListed (inherited from FTPConnection)Raise the DirectoryListed event.
RaiseDirectoryListing (inherited from FTPConnection)Raise the DirectoryListing event.
RaiseDownloaded (inherited from FTPConnection)Raise the Downloaded event.
RaiseDownloading (inherited from FTPConnection)Raise the Downloading event.
RaiseLocalDirectoryChanged (inherited from FTPConnection)Raise the LocalDirectoryChanged event.
RaiseLocalDirectoryChanging (inherited from FTPConnection)Raise the LocalDirectoryChanging event.
RaiseLoggedIn (inherited from FTPConnection)Raise the LoggedIn event.
RaiseLoggingIn (inherited from FTPConnection)Raise the LoggingIn event.
RaisePropertiesLoadedRaise the PropertiesLoaded event.
RaisePropertiesSavedRaise the PropertiesSaved event.
RaisePropertyChanged (inherited from FTPConnection)Raise the PropertyChanged event.
RaiseRenamedFile (inherited from FTPConnection)Raise the RenamedFile event.
RaiseRenamingFile (inherited from FTPConnection)Raise the RenamingFile event.
RaiseReplyReceived (inherited from FTPConnection)Raise the ReplyReceived event.
RaiseServerDirectoryChanged (inherited from FTPConnection)Raise the ServerDirectoryChanged event.
RaiseServerDirectoryChanging (inherited from FTPConnection)Raise the ServerDirectoryChanging event.
RaiseSynchronizedRaise the Synchronized event.
RaiseSynchronizingRaise the Synchronizing event.
RaiseSynchronizingFileRaise the SynchronizingFile event.
RaiseUploaded (inherited from FTPConnection)Raise the Uploaded event.
RaiseUploading (inherited from FTPConnection)Raise the Uploading event.

See Also

ExFTPConnection Class | EnterpriseDT.Net.Ftp Namespace