An NDoc Documented Class Library |

# FTPConnection Members

FTPConnection overview

#### Public Static Properties

LogFile | Name of file to which logs will be written.
LogLevel | Determines the level of logs written.
LogToConsole | Determines whether or not logs will be written to the console.
LogToTrace | Determines whether or not logs will be written using Trace.

#### Protected Static Fields

DEFAULT_WORKING_DIRECTORY | Default initial working directory.

#### Public Instance Constructors

FTPConnection | Overloaded. Initializes a new instance of the FTPConnection class.

#### Public Instance Properties

AccountInfo | Account information string.
ActivePortRange | Specifies the range of ports to be used for data-channels in active mode.
AutoFeatures | Determines if the component will automatically send the FEAT command.
AutoLogin | Determines if the component will automatically log in upon connection.
AutoPassiveIPSubstitution | Use `AutoPassiveIPSubstitution` to ensure that data-socket connections are made to the same IP address that the control socket is connected to.
BuildTimestamp | The assembly's build timestamp.
CloseStreamsAfterTransfer | Determines if transfer-methods taking Streams as arguments should close the stream once the transfer is completed.
CommandEncoding | The character-encoding to use for FTP control commands and when dealing with file- and directory-paths.
ConnectMode | The connection-mode (passive or active) of data-channels.
Container (inherited from Component) | Gets the IContainer that contains the Component.
DataEncoding | The character-encoding to use for transferring data in ASCII mode.
DeleteOnFailure | Controls whether or not a file is deleted when a failure occurs.
DirectoryEmptyMessages | Holds fragments of server messages that indicate a directory is empty.
EventsEnabled | Determines whether or not events are currently enabled.
FileInfoParser | Override the chosen file factory with a user created one - meaning that a specific parser has been selected
FileNotFoundMessages | Holds fragments of server messages that indicate a file was not found
FilePathEncoding | Obsolete. The character-encoding to use when dealing with file- and directory-paths.
IsConnected | Indicates whether the FTP client is currently connected with the server.
IsTransferring | Indicates whether the FTP client is currently transferring data.
LastTransferCancelled | Indicates whether or not the most recent transfer was cancelled.
LastValidReply | The latest valid reply from the server.
LocalDirectory | The working directory on the local file-system into which files are downloaded.
Name | Name of this component.
ParentControl | Reference to Windows Forms controls (if available).
ParsingCulture | The culture for parsing file listings.
Password | Password of account on the server.
Protocol | Type of file transfer to use.
PublicIPAddress | IP address of the client as the server sees it.
ServerAddress | The domain-name or IP address of the FTP server.
ServerDirectory | The initial/current working directory on the server.
ServerPort | The port on the server to which to connect the control-channel.
ShowHiddenFiles | Include hidden files in operations that involve listing of directories, and if supported by the server (FTP and FTPS).
Site |
StrictReturnCodes | Controls whether or not checking of return codes is strict.
SynchronizePassiveConnections | For cases where the FTP server does not properly manage PASV connections, it may be necessary to synchronize the creation of passive data sockets. It has been reported that some FTP servers (such as those at Akamai) appear to get confused when multiple FTP clients from the same IP address attempt to connect at the same time (the server sends the same port number to multiple clients).
TimeDifference | [FTP/FTPS Only] Time difference between server and client (relative to client).
TimeIncludesSeconds | [FTP/FTPS Only] Indicates whether seconds were included in the most recent directoy listing.
Timeout | TCP timeout (in milliseconds) of the underlying sockets (0 means none).
TransferBufferSize | The size of the buffers used in writing to and reading from the data-sockets.
TransferCompleteMessages | Holds fragments of server messages that indicate a transfer completed.
TransferNotifyInterval | The number of bytes transferred between each notification of the BytesTransferred event.
TransferNotifyListings | By default the BytesTransferred event is not triggered during directory listings - this property can be used to enable this behaviour.
TransferType | The current file transfer type (BINARY or ASCII).
UseGuiThreadIfAvailable | Determines whether or not event-handlers will be run on the GUI thread if one is available.
UserName | User-name of account on the server.
Version | The version of the assembly.
WelcomeMessage | Server's welcome message.
WorkingDirectory | Obsolete. The current working directory on the server.

#### Public Instance Methods

CancelResume | Cancel the resume.
CancelTransfer | Cancels the current transfer.
ChangeWorkingDirectory | Changes the working directory.
ChangeWorkingDirectoryUp | Changes to the parent of the current working directory on the server.
Close | Overloaded. Close the FTP connection.
Connect | Connect to the FTP server and (if AutoLogin is set) log into the server.
CreateDirectory | Create 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.
DeleteDirectory | Delete the specified remote directory.
DeleteFile | Delete the specified remote file.
DirectoryExists | Tests if the given directory exists.
Dispose (inherited from Component) | Overloaded. Releases all resources used by the Component.
DownloadByteArray | Download data from the FTP server and return it as a byte-array.
DownloadFile | Download a file from the FTP server and save it locally.
DownloadStream | Download 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.
GetCommandHelp | Get the help text for the specified FTP command.
GetFeatures | Get the server supplied features.
GetFileInfos | Overloaded. Returns the given directory's contents as an array of FTPFile objects.
GetFiles | Overloaded. List the given directory's contents as an array of strings of file-names or full file details.
GetHashCode | Returns hash-code for this connection.
GetLastWriteTime | Get 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.
GetSystemType | Get the type of the operating system at the server.
GetType (inherited from Object) | Gets the Type of the current instance.
GetURL | Overloaded. Returns a URL corresponding to the current state of this `SecureFTPConnection`. The URL optionally includes the directory, user-name and password.
GetWorkingDirectory | Obsolete. 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 |
Login | Log into an account on the FTP server using UserName and Password.
PostLogin | Called after the user has been successfully logged in.
RenameFile | Rename a file or directory.
ResumeTransfer | Make the next file transfer (upload or download) resume.
SendAccountInfo | 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 | Set modification time for a remote file.
ToString | Returns a string representation of the connection.
UploadByteArray | Overloaded. Upload data to the FTP server in the current working directory. Allows appending if current file exists.
UploadFile | Overloaded. Upload a local file to the FTP server in the current working directory. Allows appending if current file exists.
UploadStream | Overloaded. Upload a stream of data to the FTP server in the current working directory. Allows appending if current file exists.

#### Public Instance Events

BytesTransferred | Occurs every time a specified number of bytes of data have been transferred.
Closed | Occurs when the component has closed its connection to the server.
Closing | Occurs when the component is about to close its connection to the server.
CommandSent | Occurs when a command is sent to the server.
Connected | Occurs when the component has connected to the server.
Connecting | Occurs when the component is connecting to the server.
CreatedDirectory | Occurs when a local directory has been created on the server.
CreatingDirectory | Occurs when a directory is about to be created on the server.
Deleted | Occurs when a file has been deleted from the server.
DeletedDirectory | Occurs when a local directory has been deleted on the server.
Deleting | Occurs when a file is about to be deleted from the server.
DeletingDirectory | Occurs when a directory is about to be deleted on the server.
DirectoryChanged | Obsolete. Occurs when the server directory has been changed.
DirectoryChanging | Obsolete. Occurs when the server directory is about to be changed.
DirectoryListed | Occurs when a directory listing operations is completed.
DirectoryListing | Occurs when a directory listing operations is commenced.
Disposed (inherited from Component) | Adds an event handler to listen to the Disposed event on the component.
Downloaded | Occurs when a file has been downloaded from the server.
Downloading | Occurs when a file is about to be downloaded from the server.
LocalDirectoryChanged | Occurs when the local directory has been changed.
LocalDirectoryChanging | Occurs when the local directory is about to be changed.
LoggedIn | Occurs when the component has logged in.
LoggingIn | Occurs when the component is about to log in.
PropertyChanged | Occurs when a property is changed.
RenamedFile | Occurs when a remote file has been renamed.
RenamingFile | Occurs when a remote file is about to be renamed.
ReplyReceived | Occurs when a reply is received from the server.
ServerDirectoryChanged | Occurs when the server directory has been changed.
ServerDirectoryChanging | Occurs when the server directory is about to be changed.
Uploaded | Occurs when a file has been uploaded to the server.
Uploading | Occurs when a file is about to be uploaded to the server.

#### Protected Instance Fields

accountInfoStr | Account information string, for use in FTP/FTPS with the ACCT command.
areEventsEnabled | Determines if events will be fired.
clientLock | Used for locking connection.
fileTransferType | Record of the transfer type - make the default ASCII.
ftpClient | Instance of `FTPClient`.
ftpType | Protocol used.
guiControl | Reference to the main window.
haveQueriedForControl | Flag used to remember whether or not we've tried to find the main window yet.
isTransferringData | Determines if events will be fired.
lastTransferCancel | Flag indicating that the most recent transfer-operation was cancelled
localDir | Current local working directory.
loginPassword | Password to log in with.
loginUserName | User-name to log in with.
remoteDir | Current remote working directory.
useAutoFeatures | Determines if the components will automatically send the FEAT command after logging in.
useAutoLogin | Determines if the components will automatically log in upon connection.
useGuiThread | Flag indicating whether or not event-handlers will run on the GUI thread if one is available.

#### Protected Instance Properties

DesignMode (inherited from Component) | Gets a value that indicates whether the Component is currently in design mode.
Events (inherited from Component) | Gets the list of event handlers that are attached to this Component.

#### Protected Instance Methods

CheckFTPType | Checks the FTP type and throws an exception if it's incorrect.
Dispose | Overloaded. 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.
InvokeEventHandler | Overloaded. 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.
OnDownloaded | Overloaded. Called when a file downloading operation has completed (though it may have been cancelled).
OnDownloading | Overloaded. 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.
OnUploaded | Overloaded. Called when a file uploading operation has completed (though it may have been cancelled).
OnUploading | Overloaded. Called when a file is about to be uploaded.
PerformAutoLogin | Attempt to log into the server if AutoLogin is on.
RelativePathToAbsolute | Combines a relative path with an absolute path.

#### Protected Internal Instance Constructors

FTPConnection | Overloaded. Initializes a new instance of the FTPConnection class.

#### Protected Internal Instance Properties

ActiveClient | Reference to the currently active IFileTransferClient.

#### Protected Internal 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
ftpClient_BytesTransferred | Event-handler for BytesTransferred events received from IFileTransferClients.
ftpClient_CommandSent | Event-handler for CommandSent events received from IFileTransferClients.
ftpClient_ReplyReceived | Event-handler for ReplyReceived events received from IFileTransferClients.
InvokeDelegate | Invokes the given delegate.
RaiseBytesTransferred | Raise the BytesTransferred event.
RaiseClosed | Raise the Closed event.
RaiseClosing | Raise the Closing event.
RaiseCommandSent | Raise the CommandSent event.
RaiseConnected | Raise the Connected event.
RaiseConnecting | Raise the Connecting event.
RaiseCreatedDirectory | Raise the CreatedDirectory event.
RaiseCreatingDirectory | Raise the CreatingDirectory event.
RaiseDeleted | Raise the Deleted event.
RaiseDeletedDirectory | Raise the DeletedDirectory event.
RaiseDeleting | Raise the Deleting event.
RaiseDeletingDirectory | Raise the DeletingDirectory event.
RaiseDirectoryChanged | Raise the DirectoryChanged event.
RaiseDirectoryChanging | Raise the DirectoryChanging event.
RaiseDirectoryListed | Raise the DirectoryListed event.
RaiseDirectoryListing | Raise the DirectoryListing event.
RaiseDownloaded | Raise the Downloaded event.
RaiseDownloading | Raise the Downloading event.
RaiseLocalDirectoryChanged | Raise the LocalDirectoryChanged event.
RaiseLocalDirectoryChanging | Raise the LocalDirectoryChanging event.
RaiseLoggedIn | Raise the LoggedIn event.
RaiseLoggingIn | Raise the LoggingIn event.
RaisePropertyChanged | Raise the PropertyChanged event.
RaiseRenamedFile | Raise the RenamedFile event.
RaiseRenamingFile | Raise the RenamingFile event.
RaiseReplyReceived | Raise the ReplyReceived event.
RaiseServerDirectoryChanged | Raise the ServerDirectoryChanged event.
RaiseServerDirectoryChanging | Raise the ServerDirectoryChanging event.
RaiseUploaded | Raise the Uploaded event.
RaiseUploading | Raise the Uploading event.

#### See Also

FTPConnection Class | EnterpriseDT.Net.Ftp Namespace