Secure FTP Factory for .NET

Ftp Members

Ftp overview

Public Static Fields

AUTH_SSLThe FTP connection type.
AUTH_TLSThe FTP connection type.
DEFAULTThe default FTP connection type.
IMPLICIT_SSLThe FTP connection type.

Public Instance Constructors

Ftp Overloaded. Initializes a new instance of the Ftp class.

Public Instance Properties

BlockTransferSizeGets/Sets the Blocksize (in bytes) for use in transferring files. Default blocksize is 4096 bytes.
CertificateFile Sets the path of optional certificate file to use. Certificate file should be in X509 certificate format.
CommandConnection Gets/Sets the command connection handler.
Compression Gets or sets whether the data is compressed during the transferring. The data will be compressed if the Ftp server support this feature (MODE Z command)
Connected Checks if client is connected to FTP server.
ConnectionTypeGets/Sets the current connection type.
Container (inherited from Component)Gets the IContainer that contains the Component.
DataConnection Gets/Sets the data connection handler.
DataPortObsolete. Gets/Sets the port used for incoming data connections.
DataPortEndGets/Sets the end port used for incoming data connections.
DataPortStartGets/Sets the start port used for incoming data connections.
Debug Gets/Sets the Debugging state. By default all debugging information will be sent to Console.out stream.
DebugStream Gets/Sets the Stream used in reporting statements. By default the Console.out stream is used.
DiskEncodingGets/Sets the character encoding used when reading data from disk for ASCII file transfer.
ErrorOnSizeCommand Gets or sets the indicator value which will be used by methods that invokes GetFileSize.
FtpFileParserCreates an IFtpFileParser instance.
HostNameGets/Sets the hostname or IP address of the FTP server.
InterruptGets/Sets the current transfer state.
LicenseKey License key.
LingerGets/Sets the length of time that the TCP connection remains open after a call to Close when data remains to be sent.
LocalDirGets/Sets the local directory used in an FTP session.
NATAddress Sets the NAT Address.
Overwrite Gets or sets whether or not the component should overwrite files during downloads.
PassiveGets/Sets Passive mode for data connections.
PasswordGets/Sets the password used to log in to the FTP server.
PortGets/Sets the port of the FTP server.
PortAddress Gets or sets the external address to use when using active connections using the PORT command.
PrivateKeyFile Sets the path of private key file to use. Private key file should be in Microsoft PVK format.
ProxyHostnameGets/Sets the hostname or IP address of the Proxy server.
ProxyPasswordGets/Sets the password used to log in to the Proxy server.
ProxyPortGets/Sets the port of the Proxy server.
ProxyTypeGets/Sets the type of Proxy server.
ProxyUsernameGets/Sets the username used to log in to the Proxy server.
ReadEncoding Gets/Sets the character encoding used when reading data commands.
RemoteDirGets/Sets the remote directory on the FTP server.
Site (inherited from Component)Gets or sets the ISite of the Component.
SystemTypeGets the system type of the FTP server.
TimeoutGets/Sets the timeout (in milliseconds) for opening a connection to the FTP server.
TransferModeGets/Sets the Transfer mode.
UseEPSV Gets or sets the use EPSV command.
UserGets/Sets the username used to log in to the FTP server.
WireEncodingGets/Sets the character encoding used when issuing commands and reading files from the FTP server in ASCII mode.

Public Instance Methods

ChangePasswordChanges the password
ChangeUser Changes the currently logged-in user to the specified user without disconnecting from the FTP server.
ChecksumOverloaded. Compares checksum of the local and remote files.
ClearCommandChannel Clears command channel protection. See RFC 2228 for details.
ConnectConnects to an FTP server and performs login.
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.
DeleteDirDeletes a directory from the FTP server.
DeleteFileDeletes the remote file from the FTP server.
DirectoryExists Detects whether the specified directory exists on the server.
DirUpSets the current working directory on the FTP server to the parent directory.
DisconnectQuits FTP session and disconnects from FTP server.
Dispose (inherited from Component)Overloaded. Releases all resources used by the Component.
DownloadOverloaded. Downloads the file from the FTP server and writes the contents to the OutputStream.
DownloadDirDownloads the remote directory and all contents recursively from the FTP server.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
FileExists Detects whether the specified file exists on the server.
GetDirListingOverloaded. Gets file listing of files matching filter criteria. Filter is any regular expression supported by the FTP server.
GetDirListingArrayOverloaded. Gets the remote directory listing from the FTP server.
GetDirListingAsStringOverloaded. Gets a listing of files from the remote directory.
GetFeatures Returns server features list.
GetFeaturesArray Returns server features list.
GetFileSizeGets the file size of the remote file on the FTP server as represented in ASCII.
GetFileTimeStampGets the date/timestamp of the remote file from the FTP server.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetInputStream Gets the InputStream from the data connection.
GetLifetimeService (inherited from MarshalByRefObject)Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetMachineDirListing Returns directory listing.
GetMachineDirListingArray Returns directory listing.
GetMachineFileListing Gets the file description for the specified filename.
GetNameListingOverloaded. Gets the remote directory listing from the FTP server.
GetOutputStream Gets the OutputStream from the data connection.
GetResponseCodeReturns the code portion of the last server response.
GetType (inherited from Object)Gets the Type of the current instance.
InitializeLifetimeService (inherited from MarshalByRefObject)Obtains a lifetime service object to control the lifetime policy for this instance.
InterruptedObsolete. Checks if the transfer process was interrupted.
IsConnectedChecks if client is connected to FTP server.
IssueCommandIssues a command to the FTP server.
IssueCommandCheckIssues a command to the FTP server.
LocalDirListingGets the local directory listing.
MakeDirMakes a sub-directory on the FTP server.
MakeLocalDirCreates local directory relative to current local directory.
MDeleteOverloaded. Deletes multiple files that match the filter from the FTP server remote directory.
MDownloadOverloaded. Downloads the specified files in the current remote directory from the FTP server to the local directory.
MUploadOverloaded. Uploads multiple files from the local directory to the remote directory on the FTP server.
NoopSends a NOOP (No Operation) command to the FTP server.
RenameFileRenames the remote file on the FTP server.
ResetObsolete. Resets the interrupted flag to false.
ResumeDownloadOverloaded. Resumes the download of the remote file from the FTP server.
ResumeUploadOverloaded. Resumes the upload of the file to the FTP server.
SetClientCertificate Sets the client certificate file path. The path must denote valid .cer or PEM file. null value clears the current certificate value and forces the SSL-subsystem to not use the client certificate while SSL-handshake.
SetFileTimeStampSets the date/timestamp of the remote file from the FTP server.
SetTrustedCertificates Sets the trusted server certificates file path. The path must denote valid PKCS#12/PFX file. null value forces the SSL-subsystem to not verify the server certificate while SSL-handshake.
ToString (inherited from Component)Returns a String containing the name of the Component, if any. This method should not be overridden.
UploadOverloaded. Uploads a local file to the FTP server remote directory.
UploadDirOverloaded. Uploads the local directory and contents recursively to the FTP server.
UploadUniqueOverloaded. Uploads a local file to the FTP server remote directory.

Public Instance Events

Disposed (inherited from Component)Adds an event handler to listen to the Disposed event on the component.
FtpAuthenticatedEventOccurs when the user has been authenticated and the FTP server is established.
FtpChangeLocalDirEventOccurs when the local directory has been changed.
FtpChangeRemoteDirEventOccurs when the remote directory has been changed.
FtpCommandEventOccurs when a command is sent to the FTP server.
FtpConnectedEventOccurs when a connection to the FTP server is established.
FtpConnectionLostEventOccurs when a command connection to the FTP server is unexpectedly closed.
FtpDataConnectionLostEventOccurs when a data connection to the FTP server is unexpectedly closed.
FtpDisconnectedEventOccurs when a connection to the FTP server is released.
FtpDownloadEventOccurs when a file is downloaded from the FTP server.
FtpDownloadingEventOccurs when a file is downloading from the FTP server.
FtpListingEventOccurs when a directory listing is retrieved from the FTP server.
FtpProgressEventIndicates the transmit process.
FtpResponseEventOccurs when a response is received from the FTP server.
FtpUploadEventOccurs when a file is uploaded to the FTP server.
FtpUploadingEventOccurs when a file is uploaded to the FTP server.

Protected Instance Properties

CanRaiseEvents (inherited from Component)Gets a value indicating whether the component can raise an event.
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

DisposeOverloaded. Clean up any resources being used.
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 MarshalByRefObject)Overloaded. Creates a shallow copy of the current MarshalByRefObject object.
MemberwiseClone (inherited from Object)Overloaded. Creates a shallow copy of the current Object.

See Also

Ftp Class | Jscape.Ftp Namespace