Commercial File Transfer Protocol (FTP) Component.
The proxy scheme used by your FTP proxy server. Valid values are 0 to 6. The default value is 0 which indicates that no proxy server is used. Supported proxy methods are as follows:
Note: The ProxyHostname is the hostname of the firewall, if the proxy is a firewall. Also, the ProxyUsername and ProxyPassword are the firewall username/password (if the proxy is a firewall).
ProxyMethod = 1 (SITE site)
USER ProxyUsername
PASS ProxyPassword
SITE Hostname
USER Username
PASS Password
ProxyMethod = 2 (USER user@site)
USER Username@Hostname:Port
PASS Password
ProxyMethod = 3 (USER with login)
USER ProxyUsername
PASS ProxyPassword
USER Username@Hostname:Port
PASS Password
ProxyMethod = 4 (USER/PASS/ACCT)
USER Username@Hostname:Port ProxyUsername
PASS Password
ACCT ProxyPassword
ProxyMethod = 5 (OPEN site)
USER ProxyUsername
PASS ProxyPassword
OPEN Hostname
USER Username
PASS Password
ProxyMethod = 6 (firewallId@site)
USER ProxyUsername@Hostname
USER Username
PASS Password
ProxyMethod = 7
USER ProxyUsername
USER ProxyPassword
SITE Hostname:Port
USER Username
PASS Password
ProxyMethod = 8
USER Username@ProxyUsername@Hostname
PASS Password@ProxyPassword
property ProxyPassword: WideString
The password for authenticating with the FTP proxy server.
property ProxyPort: Integer
If an FTP proxy server is used, this is the port number at which the proxy server is listening for connections.
property ProxyUsername: WideString
The username for authenticating with the FTP proxy server.
property ReadTimeout: Integer
Forces a timeout when incoming data is expected on a data channel, but no data arrives for this number of seconds.
The ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming. During a long download, if the data stream halts for more than this amount, it will timeout. Otherwise, there is no limit on the length of time for the entire download.
The default value is 60.
property RequireSslCertVerify: Integer
If 1, then the FTP2 client will verify the server's SSL certificate. The certificate is expired, or if the cert's signature is invalid, the connection is not allowed. The default value of this property is 0.
property RestartNext: Integer
Both uploads and downloads may be resumed by simply setting this property = 1 and re-calling the upload or download method.
property SendBufferSize: Integer
The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 524288 (512K). Set it to a smaller value for more frequent percentage completion event callbacks. A larger SendBufferSize may improve performance, but at the expense not having as frequent progress monitoring callbacks (if used and if supported by your programming language).
property SessionLog: WideString readonly
Contains the session log if KeepSessionLog is turned on.
property SkipFinalReply: Integer
Special property used to help specific customers with a certain type of embedded FTP server. Do not use unless advised by Chilkat.
property SocksHostname: WideString
The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).
property SocksPassword: WideString
The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.
property SocksPort: Integer
The SOCKS4/SOCKS5 proxy port. The default value is 1080.
This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).
property SocksUsername: WideString
The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).
property SocksVersion: Integer
SocksVersion
May be set to one of the following integer values:
0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.
property Ssl: Integer
Use SSL for FTP connections. You would typically set Ssl = 1 when connecting to port 990 on FTP servers that support SSL mode. Note: It is more common to use AuthTls.
property SslProtocol: WideString
Selects the secure protocol to be used for secure (SSL/TLS) implicit and explicit (AUTH TLS / AUTH SSL) connections . Possible values are:
default
TLS 1.0
SSL 3.0
SSL 2.0
PCT 1.0
The default value is "default", which means the client/server negotiate the protocol.
property SslServerCertVerified: Integer readonly
Read-only property that returns 1 if the FTP server's digital certificate was verified when connecting via SSL / TLS.
property SyncPreview: WideString readonly
Contains the list of files that would be transferred in a call to SyncRemoteTree2 when the previewOnly argument is set to 1. This string property contains one filepath per line, separated by CRLF line endings. After SyncRemoteTree2 is called, this property contains the filepaths of the local files that would be uploaded to the FTP server.
property UploadRate: Integer readonly
The average upload rate in bytes/second. This property is updated in real-time during any FTP upload (asynchronous or synchronous).
property UseEpsv: Integer
If 1, the FTP2 component will use the EPSV command instead of PASV for passive mode data transfers. The default value of this property is 0. (It is somewhat uncommon for FTP servers to support EPSV.)
property Username: WideString
Username for logging into the FTP server. Defaults to "anonymous".
property VerboseLogging: Integer
If set to 1, then the LastErrorText may contain more verbose logging.
property Version: WideString readonly
Version of the component, such as "1.0.0"
Methods
function AppendFile(localFilename: WideString, remoteFilename: WideString): Integer;
Same as PutFile but the file on the FTP server is appended.
Returns 1 for success, 0 for failure.
function AppendFileFromBinaryData(remoteFilename: WideString, binaryData: OleVariant): Integer;
Same as PutFileFromBinaryData, except the file on the FTP server is appended.
Returns 1 for success, 0 for failure.
function AppendFileFromTextData(remoteFilename: WideString, textData: WideString, charset: WideString): Integer;
Same as PutFileFromTextData, except the file on the FTP server is appended.
Returns 1 for success, 0 for failure.
procedure AsyncAbort();
Causes an asynchronous Get or Put to abort.
function AsyncAppendFileStart(localFilename: WideString, remoteFilename: WideString): Integer;
Initiates an asynchronous append. The file is uploaded and appended to an existing file on the FTP server. The append happens in a background thread and can be aborted by calling AsyncAbort. The AsyncFinished property can be checked periodically to determine when the background transfer is finished. The status of the transfer is available in the AsyncSuccess property. The last-error information is available in the AsyncLog property. The AsyncBytesSent property is updated in real time to reflect the current number of bytes sent while the transfer is in progress. The UploadRate is also updated with the current upload rate in bytes/second. While a transfer is in progress, a program may periodically read the UploadRate and AsyncBytesSent properties to display progress.
Returns 1 for success, 0 for failure.
function AsyncGetFileStart(remoteFilename: WideString, localFilename: WideString): Integer;
Initiates an asynchronous file download. The download happens in a background thread and can be aborted by calling AsyncAbort. The AsyncFinished property can be checked periodically to determine when the background transfer is finished. The status of the transfer is available in the AsyncSuccess property. The last-error information is available in the AsyncLog property. The AsyncBytesReceived property is updated in real time to reflect the current number of bytes received while the transfer is in progress. The DownloadRate is also updated with the current download rate in bytes/second. While a transfer is in progress, a program may periodically read the DownloadRate and AsyncBytesReceived properties to display progress.
Returns 1 for success, 0 for failure.
function AsyncPutFileStart(localFilename: WideString, remoteFilename: WideString): Integer;
Initiates an asynchronous file upload. The file is uploaded and creates a new file on the FTP server, or overwrites an existing file. The upload happens in a background thread and can be aborted by calling AsyncAbort. The AsyncFinished property can be checked periodically to determine when the background transfer is finished. The status of the transfer is available in the AsyncSuccess property. The last-error information is available in the AsyncLog property. The AsyncBytesSent property is updated in real time to reflect the current number of bytes sent while the transfer is in progress. The UploadRate is also updated with the current upload rate in bytes/second. While a transfer is in progress, a program may periodically read the UploadRate and AsyncBytesSent properties to display progress.
Returns 1 for success, 0 for failure.
function ChangeRemoteDir(relativeDirPath: WideString): Integer;
Changes the current remote directory. The relativeDirPath should be relative to the current remote directory, which is initially the HOME directory of the FTP user account.
Returns 1 for success, 0 for failure.
function ClearControlChannel(): Integer;
Reverts the FTP control channel from SSL/TLS to an unencrypted channel. This may be required when using FTPS with AUTH TLS where the FTP client is behind a DSL or cable-modem router that performs NAT (network address translation). If the control channel is encrypted, the router is unable to translate the IP address sent in the PORT command for data transfers. By clearing the control channel, the data transfers will remain encrypted, but the FTP commands are passed unencrypted. Your program would typically clear the control channel after authenticating.
Returns 1 for success, 0 for failure.
procedure ClearDirCache();
TheNumFilesAndDirs property returns the count of files and sub-directories in the current remote FTP directory, according to the ListPattern property. For example, if ListPattern is set to “*.xml”, then NumFilesAndDirs returns the count of XML files in the remote directory.
The 1st time it is accessed, the component will (behind the scenes) fetch the directory listing from the FTP server. This information is cached in the component until (1) the current remote directory is changed, or (2) the ListPattern is changed, or (3) the this method (ClearDirCache) is called.
procedure ClearSessionLog();
Clears the in-memory session log.
function Connect(): Integer;
Connects and logs in to the FTP server using the username/password provided in the component properties. Check the integer value of the ConnectFailReason if this method returns 0 (indicating failure).
Returns 1 for success, 0 for failure.
function ConvertToTls(): Integer;
Explicitly converts the control channel to a secure SSL/TLS connection.
Note: If you initially connect with either the AuthTls or AuthSsl property set to 1, then DO NOT call ConvertToTls. The control channel is automatically converted to SSL/TLS from within the Connect method when these properties are set.
Note: It is very uncommon for this method to be needed.
function CreatePlan(localDir: WideString): WideString;
Creates an "FTP plan" that lists the FTP operations that would be performed when PutTree is called. Additionally, the PutPlan method executes an "FTP plan" and logs each successful operation to a plan log file. If a large-scale upload is interrupted, the PutPlan can be resumed, skipping over the operations already listed in the plan log file.
Returns a zero-length WideString on failure
function CreateRemoteDir(dir: WideString): Integer;
Creates a directory on the FTP server. If the directory already exists, a new one is not created and 0 is returned.
Returns 1 for success, 0 for failure.
function DeleteMatching(remotePattern: WideString): Integer;
Deletes all the files in the current remote FTP directory matching the pattern. Returns the number of files deleted, or -1 for failure. The pattern is a string such as "*.txt", where any number of "*" wildcard characters can be used. "*" matches 0 or more of any character.
function DeleteRemoteFile(filename: WideString): Integer;
Deletes a file on the FTP server.
Returns 1 for success, 0 for failure.
function DeleteTree(): Integer;
Deletes the entire subtree and all files from the current remote FTP directory. To delete a subtree on the FTP server, your program would first navigate to the root of the subtree to be deleted by calling ChangeRemoteDir, and then call DeleteTree. There are two event callbacks: VerifyDeleteFile and VerifyDeleteDir. Both are called prior to deleting each file or directory. The arguments to the callback include the full filepath of the file or directory, and an output-only "skip" flag. If your application sets the skip flag to true, the file or directory is NOT deleted. If a directory is not deleted, all files and sub-directories will remain. Example programs can be found at http://www.example-code.com/
Returns 1 for success, 0 for failure.
function DetermineProxyMethod(): Integer;
Automatically determines the ProxyMethod that should be used with an FTP proxy server. Tries each of the five possible ProxyMethod settings and returns the value (1-5) of the ProxyMethod that succeeded.
This method may take a minute or two to complete. Returns 0 if no proxy methods were successful. Returns -1 to indicate an error (i.e. it was unable to test all proxy methods.)
function DetermineSettings(): WideString;
Discovers which combinations of FTP2 property settings result in successful data transfers.
DetermineSettings tries 13 different combinations of these properties:
Ssl
AuthTls
AuthSsl
Port
Passive
PassiveUseHostAddr
Within the FTP protocol, the process of fetching a directory listing is also considered a “data transfer”. The DetermineSettings method works by checking to see which combinations result in a successful directory listing download. The method takes no arguments and returns a string containing an XML report of the results. It is a blocking call that may take approximately a minute to run. If you are unsure about how to interpret the results, cut-and-paste it into an email and send it to support@chilkatsoft.com.Returns a zero-length WideString on failure
function DirTreeXml(): WideString;
Recursively downloads the structure of a complete remote directory tree. Returns an XML document with the directory structure. A zero-length string is returned to indicate failure.
Returns a zero-length WideString on failure
procedure Disconnect();
Disconnects from the FTP server, ending the current session.
Returns 1 for success, 0 for failure.
function DownloadTree(localFilename: WideString): Integer;
Downloads an entire tree from the FTP server and recreates the directory tree on the local filesystem.
This method downloads all the files and subdirectories in the current remote directory. An application would first navigate to the directory to be downloaded via ChangeRemoteDir and then call this method.
There are three event callbacks (for programming languages supporting events): BeginDownloadFile, EndDownloadFile, and VerifyDownloadDir. The 1st argument to each callback is the fully qualified pathname of the file or directory. The BeginDownloadFile event callbacks has a "skip" argument, which is output-only. The application can set it to true to prevent the file from being downloaded. The VerifyDownloadDir also has a "skip" argument where the application can cause an entire sub-tree to be skipped. The EndDownloadFile event includes a "numBytes" argument containing the size of the file in bytes.
Returns 1 for success, 0 for failure.
function Feat(): WideString;
Sends a FEAT command to the FTP server and returns the response. Returns a zero-length string to indicate failure. Here is a typical response:
211-Features:
MDTM
REST STREAM
SIZE
MLST type*;size*;modify*;
MLSD
AUTH SSL
AUTH TLS
UTF8
CLNT
MFMT
211 End
Returns a zero-length WideString on failure
function GetCreateTime(index: Integer): TDateTime;
Returns the create time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)
function GetCreateTimeByName(filename: WideString): TDateTime;
Returns the file-creation time for a remote file by filename.
function GetCurrentRemoteDir(): WideString;
Returns the current remote directory.
Returns a zero-length WideString on failure
function GetFile(remoteFilename: WideString, localFilename: WideString): Integer;
Downloads a file from the FTP server to the local filesystem.
Returns 1 for success, 0 for failure.
function GetFilename(index: Integer): WideString;
Returns the filename for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)
Returns a zero-length WideString on failure
function GetIsDirectory(index: Integer): Integer;
Returns 1 for a sub-directory and 0 for a file, for the Nth entry in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)
function GetIsSymbolicLink(index: Integer): Integer;
Returns 1 if the remote file is a symbolic link. (Symbolic links only exist on Unix/Linux systems, not on Windows filesystems.)
function GetLastAccessTime(index: Integer): TDateTime;
Returns the last access time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)
function GetLastAccessTimeByName(filename: WideString): TDateTime;
Returns a remote file's last-access time.
function GetLastModifiedTime(index: Integer): TDateTime;
Returns the last modified time for the Nth file or sub-directory in the current remote directory. The first file/dir is at index 0, and the last one is at index (NumFilesAndDirs-1)
function GetLastModifiedTimeByName(filename: WideString): TDateTime;
Returns the last-modified date/time for a remote file.
function GetRemoteFileBinaryData(remoteFilename: WideString): OleVariant;
Downloads the contents of a remote file into a byte array.
Returns 1 for success, 0 for failure.
function GetRemoteFileTextC(remoteFilename: WideString, charset: WideString): WideString;
Downloads a text file directly into a string variable. The character encoding of the text file is specified by the charset argument, which is a value such as utf-8, iso-8859-1, Shift_JIS, etc.
Returns a zero-length WideString on failure
function GetRemoteFileTextData(remoteFilename: WideString): WideString;
Downloads the content of a remote text file directly into an in-memory string.
Note: If the remote text file does not use the ANSI character encoding, call GetRemoteFileTextC instead, which allows for the character encoding to be specified so that characters are properly interpreted.
Returns a zero-length WideString on failure
function GetSize(index: Integer): Integer;
Returns the size of the Nth remote file in the current directory.
function GetSizeByName(filename: WideString): Integer;
Returns a remote file's size in bytes.
function GetSizeStr(index: Integer): WideString;
Returns the size of a remote filename as a string. This is helpful for file sizes that are greater then 2GB.
Returns a zero-length WideString on failure
function GetSizeStrByName(filename: WideString): WideString;
To be documented soon...
function GetSslServerCert(): TChilkatCert;
Returns the FTP server's digital certificate (for SSL / TLS connections).
function GetTextDirListing(pattern: WideString): WideString;
Returns a listing of the files and directories in the current directory matching the pattern. Passing "*.*" will return all the files and directories.
Returns a zero-length WideString on failure
function GetXmlDirListing(pattern: WideString): WideString;
Returns (in XML format) the files and directories in the current directory matching the pattern. Passing "*.*" will return all the files and directories.
Returns a zero-length WideString on failure
function IsUnlocked(): Integer;
Return true if the component is already unlocked.
function MGetFiles(remotePattern: WideString, localDir: WideString): Integer;
Copies all the files in the current remote FTP directory to a local directory. To copy all the files in a remote directory, set remotePattern to "*.*" The pattern can contain any number of "*"characters where "*" matches 0 or more of any character. The return value is the number of files transferred, and on error, a value of -1 is returned. Detailed information about the transfer can be obtained from the last-error information (LastErrorText/LastErrorHtml/LastErrorXml/SaveLastError).
function MPutFiles(pattern: WideString): Integer;
Uploads all the files matching pattern on the local computer to the current remote FTP directory. The pattern parameter can include directory information, such as "C:/my_dir/*.txt" or it can simply be a pattern such as "*.*" that matches the files in the application's current directory. Subdirectories are not recursed. The return value is the number of files copied, with a value of -1 returned for errors. Detailed information about the transfer can be obtained from the XML log.[
function NlstXml(pattern: WideString): WideString;
To be documented soon...
function Noop(): Integer;
Issues a no-op command to the FTP server.
function PutFile(localFilename: WideString, remoteFilename: WideString): Integer;
Uploads a local file to the current directory on the FTP server.
Returns 1 for success, 0 for failure.
function PutFileFromBinaryData(remoteFilename: WideString, binaryData: OleVariant): Integer;
Creates a file on the remote server containing the data passed in a byte array.
Returns 1 for success, 0 for failure.
function PutFileFromTextData(remoteFilename: WideString, textData: WideString, charset: WideString): Integer;
Creates a file on the remote server containing the data passed in a string.
Returns 1 for success, 0 for failure.
function PutPlan(planStr: WideString, planLogFilename: WideString): Integer;
Executes an "FTP plan" (created by the CreatePlan method) and logs each successful operation to a plan log file. If a large-scale upload is interrupted, the PutPlan can be resumed, skipping over the operations already listed in the plan log file. When resuming an interrupted PutPlan method, use the same log file. All completed operations found
in the already-existing log will automatically be skipped.
Returns 1 for success, 0 for failure.
function PutTree(localDir: WideString): Integer;
Uploads an entire directory tree from the local filesystem to the remote FTP server, recreating the directory tree on the server. The PutTree method copies a directory tree to the current remote directory on the FTP server.
Returns 1 for success, 0 for failure.
function Quote(cmd: WideString): Integer;
Sends an arbitrary (raw) command to the FTP server.
Returns 1 for success, 0 for failure.
function RemoveRemoteDir(dir: WideString): Integer;
Removes a directory from the FTP server.
function RenameRemoteFile(existingFilename: WideString, newFilename: WideString): Integer;
Renames a file or directory on the FTP server. To move a file from one directory to another on a remote FTP server, call this method and include the source and destination directory filepath.
procedure SaveLastError(filename: WideString);
Saves the last error information to an XML formatted file.
function SendCommand(rawCommand: WideString): WideString;
Sends an raw command to the FTP server and returns the raw response.
Returns a zero-length WideString on failure
function SetModeZ(): Integer;
Chilkat FTP2 supports MODE Z, which is a transfer mode implemented by some FTP servers. It allows for files to be uploaded and downloaded using compressed streams (using the zlib deflate algorithm).
Call this method after connecting to enable Mode Z. Once enabled, all transfers (uploads, downloads, and directory listings) are compressed.
Returns 1 for success, 0 for failure.
procedure SetOldestDate(oldestDateTime: TDateTime);
Used in conjunction with the DownloadTree method. Call this method prior to calling DownloadTree to set the oldest date for a file to be downloaded. When DownloadTree is called, any file older than this date will not be downloaded.
function SetRemoteFileDateTime(dt: TDateTime, remoteFilename: WideString): Integer;
Sets the last-modified date/time of a file on the FTP server. Important: Not all FTP servers support this functionality. Please see the information at the Chilkat blog below:
Setting FTP date/time not supported by all FTP servers.
procedure SetSslCertRequirement(reqName: WideString, reqValue: WideString);
Enforces a requirement on the FTP server's certificate. The reqName can be "SubjectDN", "SubjectCN", "IssuerDN", or "IssuerCN". The reqName specifies the part of the certificate, and the reqValue is the value that it must match (exactly). If the FTP server's certificate does not match, the SSL / TLS connection is aborted.
procedure SetSslClientCert(iCert: TChilkatCert);
Allows for a client-side certificate to be used for the SSL / TLS connection.
function SetSslClientCertPfx(pfxFilename: WideString, pfxPassword: WideString, certSubjectCN: WideString): Integer;
To be documented soon...
function SetTypeAscii(): Integer;
Set the FTP transfer mode to us-ascii.
Returns 1 for success, 0 for failure.
function SetTypeBinary(): Integer;
Set the FTP transfer mode to binary.
Returns 1 for success, 0 for failure.
function Site(params: WideString): Integer;
Sends an arbitrary "site" command to the FTP server. The params argument should contain the parameters to the site command as they would appear on a command line. For example: "recfm=fb lrecl=600".
Returns 1 for success, 0 for failure.
procedure SleepMs(milliSec: Integer);
Causes the calling process to sleep for a number of milliseconds.
function Stat(): WideString;
Sends a STAT command to the FTP server and returns the server's reply.
Returns a zero-length WideString on failure
function SyncLocalTree(localDirRoot: WideString, mode: Integer): Integer;
Downloads files from the FTP server to a local directory tree. Synchronization modes include:
mode=0: Download all files
mode=1: Download all files that do not exist on the local filesystem.
mode=2: Download newer or non-existant files.
mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
mode=5 - Download only missing files or files with size differences.
mode=6 - Same as mode 5, but also download newer files.
* There is no mode #4. It is a mode used internally by the DirTreeXml method.
Returns 1 for success, 0 for failure.
function SyncRemoteTree(localDirRoot: WideString, mode: Integer): Integer;
Uploads a directory tree from the local filesystem to the FTP server. Synchronization modes include:
mode=0: Upload all files
mode=1: Upload all files that do not exist on the FTP server.
mode=2: Upload newer or non-existant files.
mode=3: Upload only newer files. If a file does not already exist on the FTP server, it is not uploaded.
mode=4: transfer missing files or files with size differences.
mode=5: same as mode 4, but also newer files.
Returns 1 for success, 0 for failure.
function SyncRemoteTree2(localDirPath: WideString, mode: Integer, bDescend: Integer, bPreviewOnly: Integer): Integer;
Same as SyncRemoteTree, except two extra arguments are added to allow for more flexibility. If bDescend is 0, then the directory tree is not descended and only the files in localDirPath are synchronized. If bPreviewOnly is 1 then no files are transferred and instead the files that would've been transferred (had bPreviewOnly been set to 0) are listed in the SyncPreview property.
Returns 1 for success, 0 for failure.
function Syst(): WideString;
Sends a SYST command to the FTP server to find out the type of operating
system at the server. The method returns the FTP server's response string. Refer to RFC 959 for details.
Returns a zero-length WideString on failure
function UnlockComponent(b1: WideString): Integer;
Unlocks the component. This must be called once prior to calling any other method.