An NDoc Documented Class Library

ExFTPConnection Properties

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

Public Instance Properties

AccountInfo (inherited from FTPConnection)Account information string.
ActivePortRange (inherited from FTPConnection) Specifies the range of ports to be used for data-channels in active mode.
AutoLogin (inherited from FTPConnection)Determines if the component will automatically log in upon connection.
AutoPassiveIPSubstitution (inherited from FTPConnection) Use AutoPassiveIPSubstitution to ensure that data-socket connections are made to the same IP address that the control socket is connected to.
BuildTimestamp (inherited from FTPConnection)The assembly's build timestamp.
CacheListings 
CloseStreamsAfterTransfer Determines if transfer-methods taking Streams as arguments should close the stream once the transfer is completed.
CommandEncoding The character-encoding to use when dealing with file- and directory-paths.
CompressionPreferred Flag to enable or disable MODE Z compression for FTP/FTPS transfers.
ConnectMode (inherited from FTPConnection) 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.
DefaultSyncRules Rules that are used during synchronization operations when no other rules are specified.
DeleteOnFailure Controls whether or not a file is deleted when a failure occurs.
DetectTransferMode Determines whether the transfer mode in operations involving multiple files is automatically changed between ASCII and binary as appropriate.
DirectoryEmptyMessages (inherited from FTPConnection) Holds fragments of server messages that indicate a directory is empty.
EventsEnabled (inherited from FTPConnection)Determines whether or not events are currently enabled.
FileInfoParser (inherited from FTPConnection) Override the chosen file factory with a user created one - meaning that a specific parser has been selected
FileNotFoundMessages (inherited from FTPConnection) Holds fragments of server messages that indicate a file was not found
FilePathEncoding (inherited from FTPConnection)Obsolete. The character-encoding to use when dealing with file- and directory-paths.
IntegrityCheckTransfers Control integrity checking after file transfers.
IsConnected (inherited from FTPConnection) Indicates whether the FTP client is currently connected with the server.
IsTransferring Indicates whether or not a synchronous or asynchronous transfer is currently under way.
KeepAliveIdle Flag to enable the use of keep alive messages, which are sent to keep the connection alive when no activity is occurring.
KeepAlivePeriodSecs Period (in seconds) at which the client contacts the server so that the connection doesn't time out.
KeepAliveTransfer Flag to enable the use of keep alive messages during data transfers.
LastTransferCancelled (inherited from FTPConnection) Indicates whether or not the most recent transfer was cancelled.
LastValidReply (inherited from FTPConnection)The latest valid reply from the server.
LicenseKey The license key string.
LicenseOwner The license owner string.
LocalDirectory (inherited from FTPConnection) The working directory on the local file-system into which files are downloaded.
MaxTransferRate The maximum transfer rate in bytes per sec. Set to -1 or 0 to indicate no limiting should be applied.
MultiTransferCountBeforeSleep Number of transfers before "sleeping" during multiple FTP/FTPS data transfers.
MultiTransferSleepEnabled Determines whether or not "sleeping" is enabled during multiple FTP/FTPS data transfers.
MultiTransferSleepTime Number of seconds spent "sleeping" during multiple FTP/FTPS data transfers.
ParsingCulture (inherited from FTPConnection)The culture for parsing file listings.
PasswordPassword of account on the server.
Protocol Type of file transfer to use.
ProxySettings Settings for using proxies.
PublicIPAddress (inherited from FTPConnection) IP address of the client as the server sees it.
RetryCount Number of times to retry a failing file-transfer before giving up.
RetryDelay Milliseconds to wait for before retrying a failing file-transfer (if RetryCount>0).
ServerAddress The domain-name or IP address of the FTP server.
ServerDirectory (inherited from FTPConnection) The initial/current working directory on the server.
ServerPort The port on the server to which to connect the control-channel.
ShowHiddenFiles (inherited from FTPConnection) Include hidden files in operations that involve listing of directories, and if supported by the server (FTP and FTPS).
Site (inherited from Component) Gets or sets the ISite of the Component.
SocksProxySettingsObsolete. Settings for SOCKS proxy.
StrictReturnCodes (inherited from FTPConnection)Controls whether or not checking of return codes is strict.
TimeDifference (inherited from FTPConnection) [FTP/FTPS Only] Time difference between server and client (relative to client).
TimeIncludesSeconds (inherited from FTPConnection) [FTP/FTPS Only] Indicates whether seconds were included in the most recent directoy listing.
Timeout (inherited from FTPConnection) 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 TCP sockets.
TransferCompleteMessages (inherited from FTPConnection) 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 (inherited from FTPConnection)The current file transfer type (BINARY or ASCII).
UseGuiThreadIfAvailable (inherited from FTPConnection)Determines whether or not event-handlers will be run on the GUI thread if one is available.
UserName (inherited from FTPConnection)User-name of account on the server.
Version (inherited from FTPConnection)The version of the assembly.
WelcomeMessage (inherited from FTPConnection) Server's welcome message.
WorkingDirectory (inherited from FTPConnection)Obsolete. The current working directory on the server.

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 Internal Instance Properties

ActiveClient (inherited from FTPConnection) Reference to the currently active IFileTransferClient.
ExActiveClient Reference to the currently active IExFileTransferClient.

See Also

ExFTPConnection Class | EnterpriseDT.Net.Ftp Namespace