FTP Class

Properties   Methods   Events   Config Settings   Errors  

The FTP Class can be used to transfer files to and from FTP servers using the FTP protocol.

Syntax

FTP

Remarks

The FTP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The FTP Class implements a standard FTP client as specified in RFC 959 and RFC 1579 with the added option of SSL security (RFC 2228) in both the protocol and data channels.

The first step in using the class is specifying the RemoteHost, User and Password. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is set by calling ChangeRemotePath. The Passive property is especially useful if the client is behind a firewall, which inhibits incoming connections to higher ports.

If LocalFile is set to something other than an empty string, then files are received in LocalFile, and otherwise data are received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

The PITrail event traces the interaction between the client and the server (the FTP protocol interface connection).

Directory listings are received through the DirList event.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Account Property (FTP Class)

The property includes the user account needed to log in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccount();
int SetAccount(const char* lpszAccount);

Unicode (Windows)
LPWSTR GetAccount();
INT SetAccount(LPCWSTR lpszAccount);

char* ipworks_ftp_getaccount(void* lpObj);
int ipworks_ftp_setaccount(void* lpObj, const char* lpszAccount);

QString GetAccount();
int SetAccount(QString qsAccount);

Default Value

""

Remarks

This property contains the user account to use when logging in. Some servers may require an Account to Logon or to access specific privileges, such as uploading or deleting files.

Data Type

String

Connected Property (FTP Class)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworks_ftp_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

DirList Property (FTP Class)

This is a collection of entries resulting in the last directory listing.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksDirEntry>* GetDirList();

int ipworks_ftp_getdirlistcount(void* lpObj);

char* ipworks_ftp_getdirlistentry(void* lpObj, int entryindex);

char* ipworks_ftp_getdirlistfilename(void* lpObj, int entryindex);

int64 ipworks_ftp_getdirlistfilesize(void* lpObj, int entryindex);

char* ipworks_ftp_getdirlistfiletime(void* lpObj, int entryindex);

int ipworks_ftp_getdirlistisdir(void* lpObj, int entryindex);

int GetDirListCount();

QString GetDirListEntry(int iEntryIndex);

QString GetDirListFileName(int iEntryIndex);

qint64 GetDirListFileSize(int iEntryIndex);

QString GetDirListFileTime(int iEntryIndex);

bool GetDirListIsDir(int iEntryIndex);

Remarks

This property contains the collection of entries resulting in the last directory listing. A collection is returned after a response is received from the server after a call to either ListDirectory or ListDirectoryLong. The collection is made up of entries for each listing in the current directory, which is set by calling ChangeRemotePath.

MaxDirEntries can be used to control the number of directory listings saved.

This property is read-only and not available at design time.

Data Type

IPWorksDirEntry

Firewall Property (FTP Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksFirewall* GetFirewall();
int SetFirewall(IPWorksFirewall* val);

int ipworks_ftp_getfirewallautodetect(void* lpObj);
int ipworks_ftp_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworks_ftp_getfirewalltype(void* lpObj);
int ipworks_ftp_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworks_ftp_getfirewallhost(void* lpObj);
int ipworks_ftp_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworks_ftp_getfirewallpassword(void* lpObj);
int ipworks_ftp_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworks_ftp_getfirewallport(void* lpObj);
int ipworks_ftp_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworks_ftp_getfirewalluser(void* lpObj);
int ipworks_ftp_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksFirewall

Idle Property (FTP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_ftp_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LastReply Property (FTP Class)

This property indicates the last reply received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLastReply();

Unicode (Windows)
LPWSTR GetLastReply();

char* ipworks_ftp_getlastreply(void* lpObj);

QString GetLastReply();

Default Value

""

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalFile Property (FTP Class)

This is the path to a local file for download or upload. If the file exists, it is overwritten.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* ipworks_ftp_getlocalfile(void* lpObj);
wchar_t* ipworks_ftp_getlocalfile_W(void* lpObj); // Windows only
int ipworks_ftp_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_ftp_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property is used by the Upload and Download methods to specify the path to a local file to be downloaded or uploaded. See the method descriptions for more information.

Example (Setting LocalFile)

FTPControl.LocalFile = "C:\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Download() FTPControl.LocalFile = "C:\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Download()

Data Type

String

LocalHost Property (FTP Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_ftp_getlocalhost(void* lpObj);
int ipworks_ftp_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

Overwrite Property (FTP Class)

This indicates whether or not the class should overwrite files during transfer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworks_ftp_getoverwrite(void* lpObj);
int ipworks_ftp_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property is a value indicating whether or not the class should overwrite downloaded files. If Overwrite is False, an error will be thrown whenever LocalFile exists before a download operation.

Data Type

Boolean

Passive Property (FTP Class)

This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPassive();
int SetPassive(int bPassive);

Unicode (Windows)
BOOL GetPassive();
INT SetPassive(BOOL bPassive);

int ipworks_ftp_getpassive(void* lpObj);
int ipworks_ftp_setpassive(void* lpObj, int bPassive);

bool GetPassive();
int SetPassive(bool bPassive);

Default Value

TRUE

Remarks

This property controls whether or not to direct the server into a passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them to be. If Passive is set to TRUE, the class will use the PASV command instead of the PORT command and thus will direct the server into a passive mode: connections are initiated only by the client.

Data Type

Boolean

Password Property (FTP Class)

This is the password used to log in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworks_ftp_getpassword(void* lpObj);
int ipworks_ftp_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property contains the password used to log in. It must be set before the class connects to the FTP server.

Data Type

String

RemoteFile Property (FTP Class)

This is the name of the remote file for uploading, downloading, and performing other operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteFile();
int SetRemoteFile(const char* lpszRemoteFile);

Unicode (Windows)
LPWSTR GetRemoteFile();
INT SetRemoteFile(LPCWSTR lpszRemoteFile);

char* ipworks_ftp_getremotefile(void* lpObj);
int ipworks_ftp_setremotefile(void* lpObj, const char* lpszRemoteFile);

QString GetRemoteFile();
int SetRemoteFile(QString qsRemoteFile);

Default Value

""

Remarks

This property contains the name of the remote file to be uploaded or downloaded and is either an absolute file path or a relative path based on the remote path set by calling ChangeRemotePath.

A number of methods use RemoteFile as an argument.

Example 1. Setting RemoteFile:

FTPControl.LocalFile = "C:\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Download() FTPControl.LocalFile = "C:\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Download()

Note: As long as file masks are supported by the server, then this property will act as a file mask when performing ListDirectory or ListDirectoryLong. If not supported, then ApplyFileMaskLocally could be set to True to filter the results locally.

Example 2. Using RemoteFile as a file mask: FTPControl.RemoteFile = "*.txt" FTPControl.ListDirectory()

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

String

RemoteHost Property (FTP Class)

This is the domain name or IP address of the FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost);

Unicode (Windows)
LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);

char* ipworks_ftp_getremotehost(void* lpObj);
int ipworks_ftp_setremotehost(void* lpObj, const char* lpszRemoteHost);

QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

RemotePort Property (FTP Class)

This is the port for the FTP service (default is 21).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemotePort();
int SetRemotePort(int iRemotePort);

Unicode (Windows)
INT GetRemotePort();
INT SetRemotePort(INT iRemotePort);

int ipworks_ftp_getremoteport(void* lpObj);
int ipworks_ftp_setremoteport(void* lpObj, int iRemotePort);

int GetRemotePort();
int SetRemotePort(int iRemotePort);

Default Value

21

Remarks

This property contains the port for the FTP service, which defaults to 21 if not set. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For an implicit Secure Sockets Layer (SSL), use port 990 (please see the SSLStartMode property for more information).

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCert Property (FTP Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksCertificate* val);

char* ipworks_ftp_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks_ftp_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks_ftp_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks_ftp_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks_ftp_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks_ftp_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks_ftp_getsslacceptservercertissuer(void* lpObj);

char* ipworks_ftp_getsslacceptservercertprivatekey(void* lpObj);

int ipworks_ftp_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks_ftp_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks_ftp_getsslacceptservercertpublickey(void* lpObj);

char* ipworks_ftp_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks_ftp_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks_ftp_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks_ftp_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks_ftp_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks_ftp_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks_ftp_getsslacceptservercertstorepassword(void* lpObj);
int ipworks_ftp_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks_ftp_getsslacceptservercertstoretype(void* lpObj);
int ipworks_ftp_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks_ftp_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks_ftp_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks_ftp_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks_ftp_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks_ftp_getsslacceptservercertusage(void* lpObj);

int ipworks_ftp_getsslacceptservercertusageflags(void* lpObj);

char* ipworks_ftp_getsslacceptservercertversion(void* lpObj);

char* ipworks_ftp_getsslacceptservercertsubject(void* lpObj);
int ipworks_ftp_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworks_ftp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_ftp_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksCertificate

SSLCert Property (FTP Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLCert();
int SetSSLCert(IPWorksCertificate* val);

char* ipworks_ftp_getsslcerteffectivedate(void* lpObj);

char* ipworks_ftp_getsslcertexpirationdate(void* lpObj);

char* ipworks_ftp_getsslcertextendedkeyusage(void* lpObj);

char* ipworks_ftp_getsslcertfingerprint(void* lpObj);

char* ipworks_ftp_getsslcertfingerprintsha1(void* lpObj);

char* ipworks_ftp_getsslcertfingerprintsha256(void* lpObj);

char* ipworks_ftp_getsslcertissuer(void* lpObj);

char* ipworks_ftp_getsslcertprivatekey(void* lpObj);

int ipworks_ftp_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks_ftp_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks_ftp_getsslcertpublickey(void* lpObj);

char* ipworks_ftp_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks_ftp_getsslcertpublickeylength(void* lpObj);

char* ipworks_ftp_getsslcertserialnumber(void* lpObj);

char* ipworks_ftp_getsslcertsignaturealgorithm(void* lpObj);

int ipworks_ftp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_ftp_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks_ftp_getsslcertstorepassword(void* lpObj);
int ipworks_ftp_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks_ftp_getsslcertstoretype(void* lpObj);
int ipworks_ftp_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks_ftp_getsslcertsubjectaltnames(void* lpObj);

char* ipworks_ftp_getsslcertthumbprintmd5(void* lpObj);

char* ipworks_ftp_getsslcertthumbprintsha1(void* lpObj);

char* ipworks_ftp_getsslcertthumbprintsha256(void* lpObj);

char* ipworks_ftp_getsslcertusage(void* lpObj);

int ipworks_ftp_getsslcertusageflags(void* lpObj);

char* ipworks_ftp_getsslcertversion(void* lpObj);

char* ipworks_ftp_getsslcertsubject(void* lpObj);
int ipworks_ftp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworks_ftp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_ftp_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksCertificate

SSLEnabled Property (FTP Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworks_ftp_getsslenabled(void* lpObj);
int ipworks_ftp_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (FTP Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworks_ftp_getsslprovider(void* lpObj);
int ipworks_ftp_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (FTP Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLServerCert();

char* ipworks_ftp_getsslservercerteffectivedate(void* lpObj);

char* ipworks_ftp_getsslservercertexpirationdate(void* lpObj);

char* ipworks_ftp_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks_ftp_getsslservercertfingerprint(void* lpObj);

char* ipworks_ftp_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks_ftp_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks_ftp_getsslservercertissuer(void* lpObj);

char* ipworks_ftp_getsslservercertprivatekey(void* lpObj);

int ipworks_ftp_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks_ftp_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks_ftp_getsslservercertpublickey(void* lpObj);

char* ipworks_ftp_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks_ftp_getsslservercertpublickeylength(void* lpObj);

char* ipworks_ftp_getsslservercertserialnumber(void* lpObj);

char* ipworks_ftp_getsslservercertsignaturealgorithm(void* lpObj);

int ipworks_ftp_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworks_ftp_getsslservercertstorepassword(void* lpObj);

int ipworks_ftp_getsslservercertstoretype(void* lpObj);

char* ipworks_ftp_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks_ftp_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks_ftp_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks_ftp_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks_ftp_getsslservercertusage(void* lpObj);

int ipworks_ftp_getsslservercertusageflags(void* lpObj);

char* ipworks_ftp_getsslservercertversion(void* lpObj);

char* ipworks_ftp_getsslservercertsubject(void* lpObj);

int ipworks_ftp_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksCertificate

SSLStartMode Property (FTP Class)

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworks_ftp_getsslstartmode(void* lpObj);
int ipworks_ftp_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

StartByte Property (FTP Class)

This is the byte index in RemoteFile and LocalFile from which to start a transmission.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStartByte();
int SetStartByte(const char* lpszStartByte);

Unicode (Windows)
LPWSTR GetStartByte();
INT SetStartByte(LPCWSTR lpszStartByte);

char* ipworks_ftp_getstartbyte(void* lpObj);
int ipworks_ftp_setstartbyte(void* lpObj, const char* lpszStartByte);

QString GetStartByte();
int SetStartByte(QString qsStartByte);

Default Value

"0"

Remarks

This property contains a zero-based index in both RemoteFile and LocalFile that determines the point from which the transmission of data begins. This is useful for resuming interrupted downloads and uploads of files from FTP servers.

Once set, the StartByte index is used for all future downloads and uploads. The property must be reset to "0" for normal downloads and uploads.

The type of the property is a string instead of numeric value to allow for certain implementations that expect an alphanumeric marker for the start index.

In the Transfer event, the TransferredBytes parameter will include the bytes skipped (i.e., it will show StartByte more bytes than actually transferred).

Note: Some FTP servers may not support the FTP REST command. If that is the case with the server you are accessing, you will not be able to use the StartByte property.

This property is not available at design time.

Data Type

String

Timeout Property (FTP Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_ftp_gettimeout(void* lpObj);
int ipworks_ftp_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferMode Property (FTP Class)

This property indicates the transfer mode (ASCII or binary). If the value is 0 (default), the initial server mode will be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransferMode();

Unicode (Windows)
INT GetTransferMode();

TM_DEFAULT(0), 
TM_ASCII(1), 
TM_BINARY(2)

int ipworks_ftp_gettransfermode(void* lpObj);

int GetTransferMode();

Default Value

0

Remarks

This property indicates the current transfer mode, which is either ASCII or binary. To change the transfer mode call the ChangeTransferMode method. Possible values for this property are:

This property is read-only.

Data Type

Integer

User Property (FTP Class)

This property contains the user identifier to use to log in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworks_ftp_getuser(void* lpObj);
int ipworks_ftp_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

Data Type

String

Abort Method (FTP Class)

The method aborts the current upload or download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Abort();

Unicode (Windows)
INT Abort();

int ipworks_ftp_abort(void* lpObj);

int Abort();

Remarks

This method sends an ABOR command to the FTP server. It is used to interrupt file uploads and downloads.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Append Method (FTP Class)

This method appends data from LocalFile to a RemoteFile on an FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Append();

Unicode (Windows)
INT Append();

int ipworks_ftp_append(void* lpObj);

int Append();

Remarks

This method causes the server-data transfer process (DTP) to accept the data transferred through the data connection and to store the data in a file on the server site. If the file specified in the pathname exists on the server site, then the data shall be appended to that file; otherwise, the file specified in the pathname shall be created on the server site. This method is similar to the Upload method, but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it, as with the Upload method. RemoteFile is either an absolute path on the server, or a path relative to the current path set by ChangeRemotePath. The server will create a file with that name if it doesn't already exist (similar to upload). If no FTP session is in place, one is automatically created by first calling the Logon method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangeRemotePath Method (FTP Class)

This method changes the current path on the FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeRemotePath(const char* lpszRemotePath);

Unicode (Windows)
INT ChangeRemotePath(LPCWSTR lpszRemotePath);

int ipworks_ftp_changeremotepath(void* lpObj, const char* lpszRemotePath);

int ChangeRemotePath(const QString& qsRemotePath);

Remarks

This method changes the current path on the FTP server to the specified RemotePath. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For instance:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For instance:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangeTransferMode Method (FTP Class)

This method changes the transfer mode for the current connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeTransferMode(int iTransferMode);

Unicode (Windows)
INT ChangeTransferMode(INT iTransferMode);

int ipworks_ftp_changetransfermode(void* lpObj, int iTransferMode);

int ChangeTransferMode(int iTransferMode);

Remarks

This method optionally changes the transfer mode used for the connection. The TransferMode parameter indicates the new transfer mode to be used.

In many cases, it is not necessary to explicitly change the transfer mode; however, the binary transfer mode is useful to ensure that files are preserved byte-for-byte during the transfer. For instance, when uploading or downloading images or archives, the binary transfer mode will ensure that no line-ending transformations are performed by the server before data are transmitted.

Valid values for the TransferMode parameter are as follows:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckFileExists Method (FTP Class)

This method returns True if the file specified by RemoteFile exists on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool CheckFileExists();

Unicode (Windows)
INT CheckFileExists();

bool ipworks_ftp_checkfileexists(void* lpObj);

bool CheckFileExists();

Remarks

This method sends a command to the server to determine if the file specified by RemoteFile exists. If the file exists, this method returns true, otherwise it returns false. RemoteFile must be specified before calling this method. For instance: component.ChangeRemotePath("/home/testuser/myfolder"); component.RemoteFile = "test.txt"; if(component.CheckFileExists()) { //Do something }

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Config Method (FTP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_ftp_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (FTP Class)

This method connects to the FTP server without logging in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworks_ftp_connect(void* lpObj);

int Connect();

Remarks

This method establishes a connection with the RemoteHost but does not log in. In most cases, it is recommended to use the Logon method, which will both establish a connection and log in to the server.

This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, confirming that a host is available by first creating the connection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteFile Method (FTP Class)

This method removes a file specified by FileName from an FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteFile(const char* lpszFileName);

Unicode (Windows)
INT DeleteFile(LPCWSTR lpszFileName);

int ipworks_ftp_deletefile(void* lpObj, const char* lpszFileName);

int DeleteFile(const QString& qsFileName);

Remarks

This method is used to remove a file specified by FileName from an FTP server. The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server, or a path relative to remote path set by ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Disconnect Method (FTP Class)

This method disconnects from the server without first logging off.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworks_ftp_disconnect(void* lpObj);

int Disconnect();

Remarks

This method immediately disconnects from the server without first logging off.

In most cases, the Logoff method should be used to log off and disconnect from the server. Call the Disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (FTP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_ftp_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Download Method (FTP Class)

This method downloads a RemoteFile from an FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Download();

Unicode (Windows)
INT Download();

int ipworks_ftp_download(void* lpObj);

int Download();

Remarks

This method is used to download the remote file specified by RemoteFile to the local file specified by LocalFile, or it is retrieved through the Transfer event if the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server or a path relative to a remote path set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Example (Download a File)

FTPControl.LocalFile = "C:\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Download() FTPControl.LocalFile = "C:\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Download()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (FTP Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_ftp_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListDirectory Method (FTP Class)

List the current directory specified by ChangeRemotePath on an FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListDirectory();

Unicode (Windows)
INT ListDirectory();

int ipworks_ftp_listdirectory(void* lpObj);

int ListDirectory();

Remarks

This method is used to list the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to the remote path set by ChangeRemotePath. The file listing is received through the DirList event.

Similar to ListDirectoryLong, except that only file names are returned.

Note: Because RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to an empty string or a mask like "*". If no FTP session is in place, one is automatically created by first calling the Logon method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListDirectoryLong Method (FTP Class)

This method lists extended directory information for the remote path specified by calling ChangeRemotePath .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListDirectoryLong();

Unicode (Windows)
INT ListDirectoryLong();

int ipworks_ftp_listdirectorylong(void* lpObj);

int ListDirectoryLong();

Remarks

This method is used to request a directory (or file mask) listing specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to the remote path set by calling ChangeRemotePath. The file listing is received through the DirList event. Extended file information is returned.

Note: Because RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". If no FTP session is in place, one is automatically created by first calling the Logon method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Logoff Method (FTP Class)

This method is used to log off from the FTP server by posting a QUIT command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Logoff();

Unicode (Windows)
INT Logoff();

int ipworks_ftp_logoff(void* lpObj);

int Logoff();

Remarks

This method is used to log off from the FTP server by posting a QUIT command. If that fails, the connection is terminated by the local host.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Logon Method (FTP Class)

This method is used to log on to the FTP RemoteHost using the current User and Password .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Logon();

Unicode (Windows)
INT Logon();

int ipworks_ftp_logon(void* lpObj);

int Logon();

Remarks

This method is used to log on to the FTP server using the current User and Password. If TransferMode is not 0 (Default), then the FTP transfer mode is set to the appropriate value.

Example (Logging On)

FTPControl.RemoteHost = "ftpserver" FTPControl.User = "username" FTPControl.Password = "password" FTPControl.Logon()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

MakeDirectory Method (FTP Class)

This method is used to create a directory on the FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MakeDirectory(const char* lpszNewDir);

Unicode (Windows)
INT MakeDirectory(LPCWSTR lpszNewDir);

int ipworks_ftp_makedirectory(void* lpObj, const char* lpszNewDir);

int MakeDirectory(const QString& qsNewDir);

Remarks

This method is used to create a directory with a path specified by NewDir on the FTP server. NewDir is either an absolute path on the server, or a path relative to the remote path that is set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Note: When MakeDirectory is called, RemoteFile is changed to NewDir.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

QueryFileSize Method (FTP Class)

This returns the size of the file specified by RemoteFile .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 QueryFileSize();

Unicode (Windows)
LONG64 QueryFileSize();

int64 ipworks_ftp_queryfilesize(void* lpObj);

qint64 QueryFileSize();

Remarks

This method sends the SIZE command to the server to obtain the size (in bytes) of the file specified by RemoteFile. RemoteFile must be specified before calling this method. For instance: component.ChangeRemotePath("/home/testuser/myfolder"); component.RemoteFile = "test.txt"; long myFileSize = component.QueryFileSize();

If RemoteFile does not exist on the server, the class fails with an error.

Error Handling (C++)

This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

QueryFileTime Method (FTP Class)

This returns the modified time of the file specified by RemoteFile .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* QueryFileTime();

Unicode (Windows)
LPWSTR QueryFileTime();

char* ipworks_ftp_queryfiletime(void* lpObj);

QString QueryFileTime();

Remarks

This method sends the MDTM command to the server to obtain the modified time of the file specified by RemoteFile. The time returned by this method will be converted to the local timezone. RemoteFile must be specified before calling this method. For instance: component.ChangeRemotePath("/home/testuser/myfolder"); component.RemoteFile = "test.txt"; string myModifiedTime = component.QueryFileTime();

The FileTimeFormat configuration setting controls the format of the returned value.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

QueryRemotePath Method (FTP Class)

This queries the server for the current path.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* QueryRemotePath();

Unicode (Windows)
LPWSTR QueryRemotePath();

char* ipworks_ftp_queryremotepath(void* lpObj);

QString QueryRemotePath();

Remarks

This method queries the server for the current path. When called, the class will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance:

string remotePath = component.QueryRemotePath();

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

RemoveDirectory Method (FTP Class)

This removes a directory specified by DirName from an FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveDirectory(const char* lpszDirName);

Unicode (Windows)
INT RemoveDirectory(LPCWSTR lpszDirName);

int ipworks_ftp_removedirectory(void* lpObj, const char* lpszDirName);

int RemoveDirectory(const QString& qsDirName);

Remarks

This method is used to remove a directory with path specified by DirName from the FTP server. DirName is either an absolute path on the server, or a path relative to the remote path set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RenameFile Method (FTP Class)

This changes the name of RemoteFile to NewName .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RenameFile(const char* lpszNewName);

Unicode (Windows)
INT RenameFile(LPCWSTR lpszNewName);

int ipworks_ftp_renamefile(void* lpObj, const char* lpszNewName);

int RenameFile(const QString& qsNewName);

Remarks

This method is used to change the name of a remote file, specified by RemoteFile to NewName. RemoteFile and NewName are either absolute paths on the server, or a path relative to a remote path set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (FTP Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_ftp_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCommand Method (FTP Class)

This method sends the exact command directly to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCommand(const char* lpszCommand);

Unicode (Windows)
INT SendCommand(LPCWSTR lpszCommand);

int ipworks_ftp_sendcommand(void* lpObj, const char* lpszCommand);

int SendCommand(const QString& qsCommand);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the LastReply property or monitor the PITrail event to obtain the server's response.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetDownloadStream Method (FTP Class)

This method sets the stream to which the downloaded data from the server will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDownloadStream(IPWorksStream* sDownloadStream);

Unicode (Windows)
INT SetDownloadStream(IPWorksStream* sDownloadStream);

int ipworks_ftp_setdownloadstream(void* lpObj, IPWorksStream* sDownloadStream);

int SetDownloadStream(IPWorksStream* sDownloadStream);

Remarks

This method is used to set the stream to which the downloaded data from the server will be written. If a download stream is set before the Download method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you need to call SetDownloadStream again before calling Download again. The downloaded content will be written starting at the current position in the stream. If StartByte is a non-zero value, the server will be instructed to skip those bytes before starting to send the content of the file. In that case, it is up to you to build the stream appropriately.

Note: SetDownloadStream and LocalFile will reset the other stream.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetUploadStream Method (FTP Class)

This method sets the stream from which the class will read data to upload to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUploadStream(IPWorksStream* sUploadStream);

Unicode (Windows)
INT SetUploadStream(IPWorksStream* sUploadStream);

int ipworks_ftp_setuploadstream(void* lpObj, IPWorksStream* sUploadStream);

int SetUploadStream(IPWorksStream* sUploadStream);

Remarks

This method is used to set the stream from which the class will read data to upload to the server. If an upload stream is set before the Upload method is called, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you need to call SetUploadStream again before calling Upload again. The content of the stream will be read from the current position all the way to the end, and no bytes will be skipped even if StartByte is set to a non-zero value (although the server will be instructed to skip those bytes in its file).

Note: SetUploadStream and LocalFile will reset the other stream.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StoreUnique Method (FTP Class)

This method uploads a file with a unique name to an FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StoreUnique();

Unicode (Windows)
INT StoreUnique();

int ipworks_ftp_storeunique(void* lpObj);

int StoreUnique();

Remarks

This method is used to upload a file with a unique name to an FTP server. This is similar to the Upload method, but the server determines a unique name for the LocalFile to be saved on the current directory set by calling ChangeRemotePath. The server includes the new name of the file in its response. The user should check the PITrail event, or LastReply property to retrieve this generated filename.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Upload Method (FTP Class)

This method uploads a file specified by LocalFile to an FTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Upload();

Unicode (Windows)
INT Upload();

int ipworks_ftp_upload(void* lpObj);

int Upload();

Remarks

This method uploads a local file specified by LocalFile to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to the remote path set by calling ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

If you want to append to a server file, please refer to the Append method.

Example 1: Upload a File

FTPControl.LocalFile = "C:\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Upload() FTPControl.LocalFile = "C:\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Upload()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ConnectionStatus Event (FTP Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(FTPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} FTPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(FTPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} FTPConnectionStatusEventParams;

#define EID_FTP_CONNECTIONSTATUS 1

virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class FTPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(FTPConnectionStatusEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FireConnectionStatus(FTPConnectionStatusEventParams *e) {...}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

DirList Event (FTP Class)

This event is fired when a directory entry is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDirList(FTPDirListEventParams *e);

typedef struct {
  const char *DirEntry;
  const char *FileName;
  int IsDir;
  int64 FileSize;
  const char *FileTime;
  int reserved;
} FTPDirListEventParams;


Unicode (Windows)
virtual INT FireDirList(FTPDirListEventParams *e);

typedef struct {
  LPCWSTR DirEntry;
  LPCWSTR FileName;
  BOOL IsDir;
  LONG64 FileSize;
  LPCWSTR FileTime;
  INT reserved;
} FTPDirListEventParams;

#define EID_FTP_DIRLIST 2

virtual INT IPWORKS_CALL FireDirList(LPSTR &lpszDirEntry, LPSTR &lpszFileName, BOOL &bIsDir, LONG64 &lFileSize, LPSTR &lpszFileTime);

class FTPDirListEventParams {
public:
  const QString &DirEntry();

  const QString &FileName();

  bool IsDir();

  qint64 FileSize();

  const QString &FileTime();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DirList(FTPDirListEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FireDirList(FTPDirListEventParams *e) {...}

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory or ListDirectoryLong call.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called and includes extended file information when ListDirectoryLong is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectoryLong method. Except for FileName, these parameters are empty when a short "List Directory" is performed.

In Unix systems, the date is given in two types of formats: If the date is in the past 12 months the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

EndTransfer Event (FTP Class)

This event is fired when a file finishes downloading or uploading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(FTPEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} FTPEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(FTPEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} FTPEndTransferEventParams;

#define EID_FTP_ENDTRANSFER 3

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

class FTPEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(FTPEndTransferEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FireEndTransfer(FTPEndTransferEventParams *e) {...}

Remarks

The EndTransfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (FTP Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(FTPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} FTPErrorEventParams;


Unicode (Windows)
virtual INT FireError(FTPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} FTPErrorEventParams;

#define EID_FTP_ERROR 4

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class FTPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(FTPErrorEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FireError(FTPErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

PITrail Event (FTP Class)

This event traces the commands sent to the server, and the respective replies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(FTPPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *Message;
  int reserved;
} FTPPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(FTPPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR Message;
  INT reserved;
} FTPPITrailEventParams;

#define EID_FTP_PITRAIL 5

virtual INT IPWORKS_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);

class FTPPITrailEventParams {
public:
  int Direction();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(FTPPITrailEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FirePITrail(FTPPITrailEventParams *e) {...}

Remarks

The PITrail event is useful for debugging purposes. It shows all of the interactions between the client and the server, line by line.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

SSLServerAuthentication Event (FTP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(FTPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} FTPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(FTPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} FTPSSLServerAuthenticationEventParams;

#define EID_FTP_SSLSERVERAUTHENTICATION 6

virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class FTPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(FTPSSLServerAuthenticationEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FireSSLServerAuthentication(FTPSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FTP Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(FTPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FTPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(FTPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FTPSSLStatusEventParams;

#define EID_FTP_SSLSTATUS 7

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

class FTPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(FTPSSLStatusEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FireSSLStatus(FTPSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (FTP Class)

This event fires when a file starts downloading or uploading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(FTPStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} FTPStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(FTPStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} FTPStartTransferEventParams;

#define EID_FTP_STARTTRANSFER 8

virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);

class FTPStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(FTPStartTransferEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FireStartTransfer(FTPStartTransferEventParams *e) {...}

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (FTP Class)

This event is fired during the file download or upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(FTPTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} FTPTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(FTPTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} FTPTransferEventParams;

#define EID_FTP_TRANSFER 9

virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class FTPTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(FTPTransferEventParams *e);

// Or, subclass FTP and override this emitter function.
virtual int FireTransfer(FTPTransferEventParams *e) {...}

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksCertificate (declared in ipworks.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

DirEntry Type

This is a listing in a directory returned from the server.

Syntax

IPWorksDirEntry (declared in ipworks.h)

Remarks

The DirEntry listings are filled out by the class when a directory listing is received as a response to a ListDirectory or ListDirectoryLong call. The server returns a listing for each directory and file at the current path that exists. This listing is parsed into a directory entry.

If ListDirectoryLong is called, all of the fields listed below are supplied by the server. When the ListDirectory method is called, however, the FileSize, FileTime, and IsDir fields all are left empty by the server. In this case, the only field it returns is the FileName.

The full line for the directory entry is provided by the Entry field.

Fields

Constructors

DirEntry()

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksFirewall (declared in ipworks.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

IPWorksList Type

Syntax

IPWorksList<T> (declared in ipworks.h)

Remarks

IPWorksList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the FTP class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

IPWorksStream Type

Syntax

IPWorksStream (declared in ipworks.h)

Remarks

The FTP class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksStream interface and pass the FTP class an instance of that concrete class.

When implementing the IPWorksStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (FTP Class)

FTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (FTP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

FTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors