An NDoc Documented Class Library

FTPConnection Methods

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

Public Instance Methods

CancelResumeCancel the resume.
CancelTransferCancels the current transfer.
ChangeWorkingDirectory Changes the working directory.
ChangeWorkingDirectoryUp Changes to the parent of the current working directory on the server.
CloseOverloaded. 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.
DeleteFileDelete the specified remote file.
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.
DownloadFileDownload a file from the FTP server and save it locally.
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.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
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.
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.
LinkComponent 
LoginLog into an account on the FTP server using UserName and Password.
RenameFileRename a file or directory.
ResumeTransferMake the next file transfer (upload or download) resume.
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.
ToString (inherited from Component) 
UploadByteArrayOverloaded. Upload data to the FTP server in the current working directory. Allows appending if current file exists.
UploadFileOverloaded. Upload a local file to the FTP server in the current working directory. Allows appending if current file exists.
UploadStreamOverloaded. Upload a stream of data to the FTP server in the current working directory. Allows appending if current file exists.

Protected Instance Methods

CheckConnection 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
CheckFTPType Checks the FTP type and throws and exception if it's incorrect.
DisposeOverloaded. Disconnect from the server (if connected).
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.
InvokeDelegate Invokes the given delegate.
InvokeEventHandler Invokes the given event-handler.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
OnBytesTransferred Called every time a specified number of bytes of data have been transferred.
OnChangedLocalDirectory Called when the local directory has been changed.
OnChangedServerDirectory Called when the server directory has been changed.
OnChangingLocalDirectory Called when the local directory is about to be changed.
OnChangingServerDirectory Called when the server directory is about to be changed.
OnClosed Called when a connection has closed.
OnClosing Called when a connection is about to close.
OnConnected Called when a connection-attempt has completed.
OnConnecting Called when a connection-attempt is being made.
OnCreatedDirectory Called when a directory has been created.
OnCreatingDirectory Called when a directory is about to be created.
OnDeleted Called when a file deletion operation has completed (though it may have been cancelled).
OnDeletedDirectory Called when a directory has been deleted.
OnDeleting Called when a file is about to be deleted.
OnDeletingDirectory Called when a directory is about to be deleted.
OnDirectoryListed Called when a directory listing has been retrieved.
OnDirectoryListing Called when a directory listing is about to be retrieved.
OnDownloadedOverloaded. Called when a file downloading operation has completed (though it may have been cancelled).
OnDownloadingOverloaded. Called when a file is about to be downloaded.
OnLoggedIn Called when the client has logged in.
OnLoggingIn Called when the client is about to log in.
OnPropertyChanged Called when a property has been changed.
OnRenamed Called when a file has been renamed.
OnRenaming Called when a file is about to be renamed.
OnUploadedOverloaded. Called when a file uploading operation has completed (though it may have been cancelled).
OnUploadingOverloaded. Called when a file is about to be uploaded.
PerformAutoLoginAttempt to log into the server if AutoLogin is on.
RelativePathToAbsolute Combines a relative path with an absolute path.

Protected Internal Instance Methods

ftpClient_BytesTransferred Event-handler for BytesTransferred events received from IFileTransferClients.
ftpClient_TransferCompleteEx Event-handler for TransferCompleteEx events received from IFileTransferClients.
ftpClient_TransferStartedEx Event-handler for TransferStartedEx events received from IFileTransferClients.

See Also

FTPConnection Class | EnterpriseDT.Net.Ftp Namespace