An NDoc Documented Class Library

ExFTPClient Members

ExFTPClient overview

Public Instance Constructors

ExFTPClient Constructor Initializes a new instance of the ExFTPClient class.

Public Instance Properties

ActiveIPAddress (inherited from FTPClient) Force the PORT command to send a fixed IP address, used only for certain firewalls
ActivePortRange (inherited from FTPClient) Port range for active mode, used only if it is necessary to limit the ports to a narrow range specified in a firewall
AutoPassiveIPSubstitution (inherited from FTPClient) Use AutoPassiveIPSubstitution to ensure that data-socket connections are made to the same IP address that the control socket is connected to.
CloseStreamsAfterTransfer (inherited from FTPClient) If true then streams are closed after a transfer has completed.
Connected (inherited from FTPClient) Is the client currently connected?
ConnectMode (inherited from FTPClient) The connection-mode (passive or active) of data-channels.
ControlEncoding (inherited from FTPClient) The encoding to use when dealing with file and directory paths.
ControlPort (inherited from FTPClient) The port on the server to which to connect the control-channel.
CountBeforeSleep Number of transfers before going to sleep
DataEncoding (inherited from FTPClient) The encoding to use for data when transferring in ASCII mode.
DeleteOnFailure (inherited from FTPClient) Controls whether or not a file is deleted when a failure occurs.
DetectTransferMode If set to true, the transfer mode in operations involving multiple files is automatically changed between ASCII and binary as appropriate.
DirectoryEmptyMessages (inherited from FTPClient) Holds fragments of server messages that indicate a directory is empty
FileNotFoundMessages (inherited from FTPClient) Holds fragments of server messages that indicate a file was not found
FTPFileFactory (inherited from FTPClient) Override the chosen file factory with a user created one - meaning that a specific parser has been selected.
IsConnected (inherited from FTPClient) Indicates whether the client is currently connected with the server.
LastBytesTransferred (inherited from FTPClient) The number of bytes transferred in the last transfer operation.
LastFileTransferred (inherited from FTPClient) The remote name/path of the last file transferred.
LastValidReply (inherited from FTPClient)The latest valid reply from the server.
LicenseKey The license key string.
LicenseOwner The license owner string.
MaxTransferRate The maximum transfer rate in bytes per sec
ParsingCulture (inherited from FTPClient)The culture for parsing file listings.
ProxySettings Settings for using proxies.
RemoteHost (inherited from FTPClient) The domain-name or IP address of the FTP server.
ServerWakeupInterval (inherited from FTPClient) The interval in seconds that the server is sent a wakeup message during large transfers.
ShowHiddenFiles (inherited from FTPClient) Include hidden files in operations that involve listing of directories, and if supported by the server.
SleepEnabled Enabling or not of sleeping after a certain number of transfers
SleepTime Number of seconds spent asleep
SocksContextObsolete. Controls SOCKS integration.
StrictReturnCodes (inherited from FTPClient)Controls whether or not checking of return codes is strict.
TimeDifference (inherited from FTPClient) Time difference between server and client (relative to client).
TimeIncludesSeconds (inherited from FTPClient) Indicates whether seconds were included in the most recent directoy listing.
Timeout (inherited from FTPClient) TCP timeout on the underlying sockets, in milliseconds.
TransferBufferSize (inherited from FTPClient) The size of the buffers (in bytes) used in writing to and reading from the data-sockets.
TransferCompleteMessages (inherited from FTPClient) Holds fragments of server messages that indicate a transfer completed.
TransferNotifyInterval (inherited from FTPClient) The number of bytes transferred between each notification of the BytesTransferred event.
TransferNotifyListings (inherited from FTPClient) By default the BytesTransferred event is not triggered during directory listings - this property can be used to enable this behaviour.
TransferType (inherited from FTPClient)The current file transfer type (BINARY or ASCII).
WelcomeMessage (inherited from FTPClient) Server welcome message.

Public Instance Methods

Account (inherited from FTPClient) Supply account information string to the server.
CancelResume (inherited from FTPClient) Cancel the resume. Use this method if something goes wrong and the server is left in an inconsistent state
CancelTransfer (inherited from FTPClient)Cancels the current transfer.
CdUp (inherited from FTPClient)Change the remote working directory to the parent directory.
ChDir (inherited from FTPClient)Change the remote working directory to that supplied.
Connect Connects to the FTP server.
DebugResponses (inherited from FTPClient)Switch debug of responses on or off
Delete (inherited from FTPClient)Delete the specified remote file.
Dir (inherited from FTPClient)Overloaded. List a directory's contents as an array of strings of filenames.
DirDetailsOverloaded. Returns the given directory's contents and optionally that of its subdirectories as an array of FTPFile objects.
DirDetails (inherited from FTPClient)Overloaded. List the current directory's contents as an array of FTPFile objects.
EnableModeZCompression Set MODE Z so that all subsequent transfers are compressed. Not supported by some servers
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
Exists (inherited from FTPClient) Checks for the existence of a file on the server.
Features (inherited from FTPClient)Get the server supplied features.
Get (inherited from FTPClient)Overloaded. Get data from the FTP server.
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.
GetLocalCRC Get the CRC-32 checksum for the named local file
GetRemoteCRC Get the CRC-32 checksum for the named remote file
GetSystem (inherited from FTPClient)Get the type of the OS at the server.
GetType (inherited from Object) Gets the Type of the current instance.
Help (inherited from FTPClient) Get the help text for the specified command
KillControlChannel (inherited from FTPClient) 
Login (inherited from FTPClient)Login into an account on the FTP server using the user-name and password provided.
MkDir (inherited from FTPClient)Create the specified remote working directory.
ModTime (inherited from FTPClient)Get modification time for a remote file.
MultipleDeleteOverloaded. Delete multiple files in the current remote directory and its subdirectories.
MultipleDeleteDirectories Remove a remote directory, and all its files and its subdirectories
MultipleGetOverloaded. Get multiple files from the specified remote directory into the specified local directory
MultiplePutOverloaded. Put multiple files from the specified local directory into the specified remote directory
NoOperation (inherited from FTPClient) Send a "no operation" message that does nothing, which can be called periodically to prevent the connection timing out.
Password (inherited from FTPClient) Supplies the password for a previously supplied user-name to log into the FTP server. Must be preceeded by the User method
Put (inherited from FTPClient)Overloaded. Put a stream of data onto the FTP server in the current directory. Allows appending if current file exists
Pwd (inherited from FTPClient)Get the current remote working directory.
Quit (inherited from FTPClient)Quit the FTP session by sending a QUIT command before closing the socket.
QuitImmediately (inherited from FTPClient) Quit the FTP session immediately by closing the control socket without sending the QUIT command.
Quote (inherited from FTPClient)Issue arbitrary ftp commands to the FTP server.
Rename (inherited from FTPClient)Rename a file or directory.
Restart (inherited from FTPClient)Set the REST marker so that the next transfer doesn't start at the beginning of the remote file
Resume (inherited from FTPClient)Make the next file transfer (put or get) resume.
RmDir (inherited from FTPClient)Delete the specified remote working directory.
SetModTime (inherited from FTPClient)Sets the modification time of a remote file.
Site (inherited from FTPClient)Run a site-specific command on the server.
Size (inherited from FTPClient) Get the size of a remote file.
ToString (inherited from Object) Returns a String that represents the current Object.
Unlock Unlock the software for use. This method should be used when a configuration file isn't available
User (inherited from FTPClient) Supply the user-name to log into an account on the FTP server. Must be followed by the Password method. Note that Connect must be called first.
ValidateTransfer (inherited from FTPClient)Validate that the Put() or get() was successful.

Public Instance Events

BytesTransferred (inherited from FTPClient) Event triggered every time TransferNotifyInterval bytes transferred.
CommandSent (inherited from FTPClient) Triggered every time a command is sent to the server.
ReplyReceived (inherited from FTPClient) Triggered every time a reply is received from the server.
TransferComplete (inherited from FTPClient)Obsolete. Notifies of the completion of a transfer.
TransferCompleteEx (inherited from FTPClient) Notifies of the completion of a transfer, and supplies more details than TransferComplete
TransferStarted (inherited from FTPClient)Obsolete. Notifies of the start of a transfer.
TransferStartedEx (inherited from FTPClient) Notifies of the start of a transfer, and supplies more details than TransferStarted

Protected Instance Fields

key License key
noOperationInterval (inherited from FTPClient) Interval for NOOP calls during large transfers in seconds
owner License owner
throttler (inherited from FTPClient) Threshold for throttling

Protected Instance Methods

Abort (inherited from FTPClient)Abort the current action.
CloseDataSocket (inherited from FTPClient)Overloaded.  
Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetInputStream 
GetOutputStream 
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
ValidateTransferOnError (inherited from FTPClient) Validate a transfer when an error has occurred on the data channel. Set a very short transfer in case things have hung. Set it back at the end.

Protected Internal Instance Fields

socks SOCKS settings

See Also

ExFTPClient Class | EnterpriseDT.Net.Ftp Namespace