SFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The SFTPClient class can be used to transfer files to and from secure file transfer protocol (SFTP) servers.

Syntax

SFTPClient

Remarks

The SFTPClient class is the Secure Shell (SSH)-enabled equivalent of the IPWorks FTP class. The SSHHost and SSHPort properties specify which Secure Shell (SSH) server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

The SFTPClient class implements a standard SSH file transfer client.

The first step in using the class is specifying the SSHHost, SSHUser, and SSHPassword. 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 specified by the RemotePath property.

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

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.

Connected Property (SFTPClient Class)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworkssftp_sftpclient_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 (SFTPClient Class)

Collection of entries resulting in the last directory listing.

Syntax

• C++
• C
• Qt

IPWorksSFTPList<IPWorksSFTPDirEntry>* GetDirList();

int ipworkssftp_sftpclient_getdirlistcount(void* lpObj);

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

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

int64 ipworkssftp_sftpclient_getdirlistfilesize(void* lpObj, int entryindex);

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

int ipworkssftp_sftpclient_getdirlistisdir(void* lpObj, int entryindex);

int ipworkssftp_sftpclient_getdirlistissymlink(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);

bool GetDirListIsSymlink(int iEntryIndex);

Remarks

This collection of entries is returned after a response is received from the server after a call to ListDirectory. The collection is made up of entries for each listing in the current directory, which is specified by the RemotePath property.

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

IPWorksSFTPDirEntry

FileAttributes Property (SFTPClient Class)

The attributes of the RemoteFile .

Syntax

• C++
• C
• Qt

IPWorksSFTPSFTPFileAttributes* GetFileAttributes();
int SetFileAttributes(IPWorksSFTPSFTPFileAttributes* val);

int64 ipworkssftp_sftpclient_getfileaccesstime(void* lpObj);
int ipworkssftp_sftpclient_setfileaccesstime(void* lpObj, int64 lFileAccessTime);

char* ipworkssftp_sftpclient_getfileacl(void* lpObj);
int ipworkssftp_sftpclient_setfileacl(void* lpObj, const char* lpszFileACL);

int64 ipworkssftp_sftpclient_getfileallocationsize(void* lpObj);

int ipworkssftp_sftpclient_getfileattributebits(void* lpObj);

int ipworkssftp_sftpclient_getfileattributebitsvalid(void* lpObj);

int64 ipworkssftp_sftpclient_getfilecreationtime(void* lpObj);
int ipworkssftp_sftpclient_setfilecreationtime(void* lpObj, int64 lFileCreationTime);

int ipworkssftp_sftpclient_getfiletype(void* lpObj);

char* ipworkssftp_sftpclient_getfilegroupid(void* lpObj);
int ipworkssftp_sftpclient_setfilegroupid(void* lpObj, const char* lpszFileGroupId);

int ipworkssftp_sftpclient_getfileisdir(void* lpObj);

int ipworkssftp_sftpclient_getfileissymlink(void* lpObj);

int64 ipworkssftp_sftpclient_getfilemodifiedtime(void* lpObj);
int ipworkssftp_sftpclient_setfilemodifiedtime(void* lpObj, int64 lFileModifiedTime);

char* ipworkssftp_sftpclient_getfileownerid(void* lpObj);
int ipworkssftp_sftpclient_setfileownerid(void* lpObj, const char* lpszFileOwnerId);

int ipworkssftp_sftpclient_getfilepermissions(void* lpObj);
int ipworkssftp_sftpclient_setfilepermissions(void* lpObj, int iFilePermissions);

char* ipworkssftp_sftpclient_getfilepermissionsoctal(void* lpObj);
int ipworkssftp_sftpclient_setfilepermissionsoctal(void* lpObj, const char* lpszFilePermissionsOctal);

int64 ipworkssftp_sftpclient_getfilesize(void* lpObj);

qint64 GetFileAccessTime();
int SetFileAccessTime(qint64 lFileAccessTime);

QString GetFileACL();
int SetFileACL(QString qsFileACL);

qint64 GetFileAllocationSize();

int GetFileAttributeBits();

int GetFileAttributeBitsValid();

qint64 GetFileCreationTime();
int SetFileCreationTime(qint64 lFileCreationTime);

int GetFileType();

QString GetFileGroupId();
int SetFileGroupId(QString qsFileGroupId);

bool GetFileIsDir();

bool GetFileIsSymlink();

qint64 GetFileModifiedTime();
int SetFileModifiedTime(qint64 lFileModifiedTime);

QString GetFileOwnerId();
int SetFileOwnerId(QString qsFileOwnerId);

int GetFilePermissions();
int SetFilePermissions(int iFilePermissions);

QString GetFilePermissionsOctal();
int SetFilePermissionsOctal(QString qsFilePermissionsOctal);

qint64 GetFileSize();

Remarks

This property holds the attributes for the file specified by RemoteFile. Before querying this property, first call QueryFileAttributes to retrieve the attributes from the server.

To modify the attributes of the file, you may set FileAttributes and then call UpdateFileAttributes.

This property is not available at design time.

Data Type

IPWorksSFTPSFTPFileAttributes

Firewall Property (SFTPClient Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int ipworkssftp_sftpclient_getfirewallautodetect(void* lpObj);
int ipworkssftp_sftpclient_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworkssftp_sftpclient_getfirewalltype(void* lpObj);
int ipworkssftp_sftpclient_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworkssftp_sftpclient_getfirewallhost(void* lpObj);
int ipworkssftp_sftpclient_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworkssftp_sftpclient_getfirewallpassword(void* lpObj);
int ipworkssftp_sftpclient_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworkssftp_sftpclient_getfirewallport(void* lpObj);
int ipworkssftp_sftpclient_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworkssftp_sftpclient_getfirewalluser(void* lpObj);
int ipworkssftp_sftpclient_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

IPWorksSFTPFirewall

Idle Property (SFTPClient Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworkssftp_sftpclient_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

LocalFile Property (SFTPClient Class)

The path to a local file for upload or download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
int SetLocalFile(const char* lpszLocalFile);

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

char* ipworkssftp_sftpclient_getlocalfile(void* lpObj);
int ipworkssftp_sftpclient_setlocalfile(void* lpObj, const char* lpszLocalFile);

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

Default Value

""

Remarks

The LocalFile property is used by the Upload and Download methods. The file will be overwritten only if the Overwrite property is set to True.

Example. Setting LocalFile:

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

Data Type

String

LocalHost Property (SFTPClient 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* ipworkssftp_sftpclient_getlocalhost(void* lpObj);
int ipworkssftp_sftpclient_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

LocalPort Property (SFTPClient Class)

The TCP port in the local host where the class binds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworkssftp_sftpclient_getlocalport(void* lpObj);
int ipworkssftp_sftpclient_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port on the client side.

Data Type

Integer

Overwrite Property (SFTPClient Class)

The value indicating 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 ipworkssftp_sftpclient_getoverwrite(void* lpObj);
int ipworkssftp_sftpclient_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 LocalFile when downloading and RemoteFile when uploading. If Overwrite is False, an error will be thrown whenever LocalFile exists before a download operation.

Data Type

Boolean

RemoteFile Property (SFTPClient Class)

The name of the remote file for uploading or downloading.

Syntax

• C++
• C
• Qt

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

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

char* ipworkssftp_sftpclient_getremotefile(void* lpObj);
int ipworkssftp_sftpclient_setremotefile(void* lpObj, const char* lpszRemoteFile);

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

Default Value

""

Remarks

The RemoteFile is either an absolute file path or a relative path based on RemotePath.

A number of methods use RemoteFile as an argument.

Example 1. Setting RemoteFile:

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

Note: This property will also act as a file mask when performing ListDirectory.

Example 2. Using RemoteFile as a File Mask: SFTPControl.RemoteFile = "*.txt" SFTPControl.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

RemotePath Property (SFTPClient Class)

The current path in the secure file transfer protocol (SFTP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemotePath();

Unicode (Windows)
LPWSTR GetRemotePath();

char* ipworkssftp_sftpclient_getremotepath(void* lpObj);

QString GetRemotePath();

Default Value

""

Remarks

The RemotePath shows the current working directory on the SFTP server. The ChangeRemotePath method can be used to change the working directory to an absolute directory path or to a relative path with respect to the current value of RemotePath.

Example. Changing Directory:

sftp1.SSHLogon("sftp.server.net", 22); sftp1.ChangeRemotePath("/home/user");

This property is read-only.

Data Type

String

SSHAcceptServerHostKey Property (SFTPClient Class)

Instructs the class to accept the server host key that matches the supplied key.

Syntax

• C++
• C
• Qt

IPWorksSFTPCertificate* GetSSHAcceptServerHostKey();
int SetSSHAcceptServerHostKey(IPWorksSFTPCertificate* val);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyeffectivedate(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyexpirationdate(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyextendedkeyusage(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyfingerprint(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyfingerprintsha1(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyfingerprintsha256(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyissuer(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyprivatekey(void* lpObj);

int ipworkssftp_sftpclient_getsshacceptserverhostkeyprivatekeyavailable(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyprivatekeycontainer(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeypublickey(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeypublickeyalgorithm(void* lpObj);

int ipworkssftp_sftpclient_getsshacceptserverhostkeypublickeylength(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyserialnumber(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeysignaturealgorithm(void* lpObj);

int ipworkssftp_sftpclient_getsshacceptserverhostkeystore(void* lpObj, char** lpSSHAcceptServerHostKeyStore, int* lenSSHAcceptServerHostKeyStore);
int ipworkssftp_sftpclient_setsshacceptserverhostkeystore(void* lpObj, const char* lpSSHAcceptServerHostKeyStore, int lenSSHAcceptServerHostKeyStore);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeystorepassword(void* lpObj);
int ipworkssftp_sftpclient_setsshacceptserverhostkeystorepassword(void* lpObj, const char* lpszSSHAcceptServerHostKeyStorePassword);

int ipworkssftp_sftpclient_getsshacceptserverhostkeystoretype(void* lpObj);
int ipworkssftp_sftpclient_setsshacceptserverhostkeystoretype(void* lpObj, int iSSHAcceptServerHostKeyStoreType);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeysubjectaltnames(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeythumbprintmd5(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeythumbprintsha1(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeythumbprintsha256(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyusage(void* lpObj);

int ipworkssftp_sftpclient_getsshacceptserverhostkeyusageflags(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeyversion(void* lpObj);

char* ipworkssftp_sftpclient_getsshacceptserverhostkeysubject(void* lpObj);
int ipworkssftp_sftpclient_setsshacceptserverhostkeysubject(void* lpObj, const char* lpszSSHAcceptServerHostKeySubject);

int ipworkssftp_sftpclient_getsshacceptserverhostkeyencoded(void* lpObj, char** lpSSHAcceptServerHostKeyEncoded, int* lenSSHAcceptServerHostKeyEncoded);
int ipworkssftp_sftpclient_setsshacceptserverhostkeyencoded(void* lpObj, const char* lpSSHAcceptServerHostKeyEncoded, int lenSSHAcceptServerHostKeyEncoded);

QString GetSSHAcceptServerHostKeyEffectiveDate();

QString GetSSHAcceptServerHostKeyExpirationDate();

QString GetSSHAcceptServerHostKeyExtendedKeyUsage();

QString GetSSHAcceptServerHostKeyFingerprint();

QString GetSSHAcceptServerHostKeyFingerprintSHA1();

QString GetSSHAcceptServerHostKeyFingerprintSHA256();

QString GetSSHAcceptServerHostKeyIssuer();

QString GetSSHAcceptServerHostKeyPrivateKey();

bool GetSSHAcceptServerHostKeyPrivateKeyAvailable();

QString GetSSHAcceptServerHostKeyPrivateKeyContainer();

QString GetSSHAcceptServerHostKeyPublicKey();

QString GetSSHAcceptServerHostKeyPublicKeyAlgorithm();

int GetSSHAcceptServerHostKeyPublicKeyLength();

QString GetSSHAcceptServerHostKeySerialNumber();

QString GetSSHAcceptServerHostKeySignatureAlgorithm();

QByteArray GetSSHAcceptServerHostKeyStore();
int SetSSHAcceptServerHostKeyStore(QByteArray qbaSSHAcceptServerHostKeyStore);

QString GetSSHAcceptServerHostKeyStorePassword();
int SetSSHAcceptServerHostKeyStorePassword(QString qsSSHAcceptServerHostKeyStorePassword);

int GetSSHAcceptServerHostKeyStoreType();
int SetSSHAcceptServerHostKeyStoreType(int iSSHAcceptServerHostKeyStoreType);

QString GetSSHAcceptServerHostKeySubjectAltNames();

QString GetSSHAcceptServerHostKeyThumbprintMD5();

QString GetSSHAcceptServerHostKeyThumbprintSHA1();

QString GetSSHAcceptServerHostKeyThumbprintSHA256();

QString GetSSHAcceptServerHostKeyUsage();

int GetSSHAcceptServerHostKeyUsageFlags();

QString GetSSHAcceptServerHostKeyVersion();

QString GetSSHAcceptServerHostKeySubject();
int SetSSHAcceptServerHostKeySubject(QString qsSSHAcceptServerHostKeySubject);

QByteArray GetSSHAcceptServerHostKeyEncoded();
int SetSSHAcceptServerHostKeyEncoded(QByteArray qbaSSHAcceptServerHostKeyEncoded);

Remarks

If the host key that will be used by the server is known in advance, this property may be set to accept the expected key. Otherwise, the SSHServerAuthentication event should be trapped, and the key should be accepted or refused in the event.

If this property is not set and the SSHServerAuthentication event is not trapped, the server will not be authenticated and the connection will be terminated by the client.

Data Type

IPWorksSFTPCertificate

SSHAuthMode Property (SFTPClient Class)

The authentication method to be used with the class when calling SSHLogon .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHAuthMode();
int SetSSHAuthMode(int iSSHAuthMode);

Unicode (Windows)
INT GetSSHAuthMode();
INT SetSSHAuthMode(INT iSSHAuthMode);

AM_NONE(0), 
AM_MULTI_FACTOR(1), 
AM_PASSWORD(2), 
AM_PUBLIC_KEY(3), 
AM_KEYBOARD_INTERACTIVE(4), 
AM_GSSAPIWITH_MIC(5), 
AM_GSSAPIKEYEX(6), 
AM_CUSTOM(99)

int ipworkssftp_sftpclient_getsshauthmode(void* lpObj);
int ipworkssftp_sftpclient_setsshauthmode(void* lpObj, int iSSHAuthMode);

int GetSSHAuthMode();
int SetSSHAuthMode(int iSSHAuthMode);

Default Value

2

Remarks

The Secure Shell (SSH) Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.

The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

Integer

SSHCert Property (SFTPClient Class)

A certificate to be used for authenticating the SSHUser .

Syntax

• C++
• C
• Qt

IPWorksSFTPCertificate* GetSSHCert();
int SetSSHCert(IPWorksSFTPCertificate* val);

char* ipworkssftp_sftpclient_getsshcerteffectivedate(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertexpirationdate(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertextendedkeyusage(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertfingerprint(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertfingerprintsha1(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertfingerprintsha256(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertissuer(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertprivatekey(void* lpObj);

int ipworkssftp_sftpclient_getsshcertprivatekeyavailable(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertprivatekeycontainer(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertpublickey(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertpublickeyalgorithm(void* lpObj);

int ipworkssftp_sftpclient_getsshcertpublickeylength(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertserialnumber(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertsignaturealgorithm(void* lpObj);

int ipworkssftp_sftpclient_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworkssftp_sftpclient_setsshcertstore(void* lpObj, const char* lpSSHCertStore, int lenSSHCertStore);

char* ipworkssftp_sftpclient_getsshcertstorepassword(void* lpObj);
int ipworkssftp_sftpclient_setsshcertstorepassword(void* lpObj, const char* lpszSSHCertStorePassword);

int ipworkssftp_sftpclient_getsshcertstoretype(void* lpObj);
int ipworkssftp_sftpclient_setsshcertstoretype(void* lpObj, int iSSHCertStoreType);

char* ipworkssftp_sftpclient_getsshcertsubjectaltnames(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertthumbprintmd5(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertthumbprintsha1(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertthumbprintsha256(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertusage(void* lpObj);

int ipworkssftp_sftpclient_getsshcertusageflags(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertversion(void* lpObj);

char* ipworkssftp_sftpclient_getsshcertsubject(void* lpObj);
int ipworkssftp_sftpclient_setsshcertsubject(void* lpObj, const char* lpszSSHCertSubject);

int ipworkssftp_sftpclient_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworkssftp_sftpclient_setsshcertencoded(void* lpObj, const char* lpSSHCertEncoded, int lenSSHCertEncoded);

QString GetSSHCertEffectiveDate();

QString GetSSHCertExpirationDate();

QString GetSSHCertExtendedKeyUsage();

QString GetSSHCertFingerprint();

QString GetSSHCertFingerprintSHA1();

QString GetSSHCertFingerprintSHA256();

QString GetSSHCertIssuer();

QString GetSSHCertPrivateKey();

bool GetSSHCertPrivateKeyAvailable();

QString GetSSHCertPrivateKeyContainer();

QString GetSSHCertPublicKey();

QString GetSSHCertPublicKeyAlgorithm();

int GetSSHCertPublicKeyLength();

QString GetSSHCertSerialNumber();

QString GetSSHCertSignatureAlgorithm();

QByteArray GetSSHCertStore();
int SetSSHCertStore(QByteArray qbaSSHCertStore);

QString GetSSHCertStorePassword();
int SetSSHCertStorePassword(QString qsSSHCertStorePassword);

int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType);

QString GetSSHCertSubjectAltNames();

QString GetSSHCertThumbprintMD5();

QString GetSSHCertThumbprintSHA1();

QString GetSSHCertThumbprintSHA256();

QString GetSSHCertUsage();

int GetSSHCertUsageFlags();

QString GetSSHCertVersion();

QString GetSSHCertSubject();
int SetSSHCertSubject(QString qsSSHCertSubject);

QByteArray GetSSHCertEncoded();
int SetSSHCertEncoded(QByteArray qbaSSHCertEncoded);

Remarks

To use public key authentication, SSHCert must contain a Certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user, and then it will attempt to use those values to verify the signature.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

IPWorksSFTPCertificate

SSHCompressionAlgorithms Property (SFTPClient Class)

The comma-separated list containing all allowable compression algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(const char* lpszSSHCompressionAlgorithms);

Unicode (Windows)
LPWSTR GetSSHCompressionAlgorithms();
INT SetSSHCompressionAlgorithms(LPCWSTR lpszSSHCompressionAlgorithms);

char* ipworkssftp_sftpclient_getsshcompressionalgorithms(void* lpObj);
int ipworkssftp_sftpclient_setsshcompressionalgorithms(void* lpObj, const char* lpszSSHCompressionAlgorithms);

QString GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(QString qsSSHCompressionAlgorithms);

Default Value

"none,zlib"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:

• zlib
• zlib@openssh.com
• none

Data Type

String

SSHEncryptionAlgorithms Property (SFTPClient Class)

The comma-separated list containing all allowable encryption algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(const char* lpszSSHEncryptionAlgorithms);

Unicode (Windows)
LPWSTR GetSSHEncryptionAlgorithms();
INT SetSSHEncryptionAlgorithms(LPCWSTR lpszSSHEncryptionAlgorithms);

char* ipworkssftp_sftpclient_getsshencryptionalgorithms(void* lpObj);
int ipworkssftp_sftpclient_setsshencryptionalgorithms(void* lpObj, const char* lpszSSHEncryptionAlgorithms);

QString GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(QString qsSSHEncryptionAlgorithms);

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:

Data Type

String

SSHHost Property (SFTPClient Class)

The address of the Secure Shell (SSH) host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHHost();
int SetSSHHost(const char* lpszSSHHost);

Unicode (Windows)
LPWSTR GetSSHHost();
INT SetSSHHost(LPCWSTR lpszSSHHost);

char* ipworkssftp_sftpclient_getsshhost(void* lpObj);
int ipworkssftp_sftpclient_setsshhost(void* lpObj, const char* lpszSSHHost);

QString GetSSHHost();
int SetSSHHost(QString qsSSHHost);

Default Value

""

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

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

The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.

Data Type

String

SSHPassword Property (SFTPClient Class)

The password for Secure Shell (SSH) password-based authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHPassword();
int SetSSHPassword(const char* lpszSSHPassword);

Unicode (Windows)
LPWSTR GetSSHPassword();
INT SetSSHPassword(LPCWSTR lpszSSHPassword);

char* ipworkssftp_sftpclient_getsshpassword(void* lpObj);
int ipworkssftp_sftpclient_setsshpassword(void* lpObj, const char* lpszSSHPassword);

QString GetSSHPassword();
int SetSSHPassword(QString qsSSHPassword);

Default Value

""

Remarks

SSHPassword specifies the password that is used to authenticate the client to the SSH server.

Data Type

String

SSHPort Property (SFTPClient Class)

The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSHPort();
int SetSSHPort(int iSSHPort);

Unicode (Windows)
INT GetSSHPort();
INT SetSSHPort(INT iSSHPort);

int ipworkssftp_sftpclient_getsshport(void* lpObj);
int ipworkssftp_sftpclient_setsshport(void* lpObj, int iSSHPort);

int GetSSHPort();
int SetSSHPort(int iSSHPort);

Default Value

22

Remarks

The SSHPort specifies a service port on the SSH host to connect to.

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.

Data Type

Integer

SSHUser Property (SFTPClient Class)

The username for Secure Shell (SSH) authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHUser();
int SetSSHUser(const char* lpszSSHUser);

Unicode (Windows)
LPWSTR GetSSHUser();
INT SetSSHUser(LPCWSTR lpszSSHUser);

char* ipworkssftp_sftpclient_getsshuser(void* lpObj);
int ipworkssftp_sftpclient_setsshuser(void* lpObj, const char* lpszSSHUser);

QString GetSSHUser();
int SetSSHUser(QString qsSSHUser);

Default Value

""

Remarks

SSHUser specifies the username that is used to authenticate the client to the SSH server. This property is required.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

String

StartByte Property (SFTPClient Class)

The offset in bytes at which to begin the upload or download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetStartByte();
int SetStartByte(int64 lStartByte);

Unicode (Windows)
LONG64 GetStartByte();
INT SetStartByte(LONG64 lStartByte);

int64 ipworkssftp_sftpclient_getstartbyte(void* lpObj);
int ipworkssftp_sftpclient_setstartbyte(void* lpObj, int64 lStartByte);

qint64 GetStartByte();
int SetStartByte(qint64 lStartByte);

Default Value

0

Remarks

The StartByte property is used by the Upload and Download methods to determine at what offset to begin the transfer. This allows for resuming both uploads and downloads. The value of this property is reset to 0 after a successful transfer. StartByte is not valid for use with Append.

When downloading, this property can be used in conjunction with the TransferredDataLimit configuration setting to download only a specific range of data from the current RemoteFile.

Data Type

Long64

Timeout Property (SFTPClient 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 ipworkssftp_sftpclient_gettimeout(void* lpObj);
int ipworkssftp_sftpclient_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

Append Method (SFTPClient Class)

Append data from LocalFile to a remote file RemoteFile on a Secure File Transfer Protocol (SFTP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Append();

Unicode (Windows)
INT Append();

int ipworkssftp_sftpclient_append(void* lpObj);

int Append();

Remarks

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 RemotePath. The server will create a file with that name if it does not already exist (similar to upload).

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

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 (SFTPClient Class)

Changes the current path on the server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ChangeRemotePath(LPCWSTR lpszRemotePath);

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

int ChangeRemotePath(const QString& qsRemotePath);

Remarks

This method changes the current path on the 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 example:

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 example:

//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.)

CheckFileExists Method (SFTPClient Class)

Returns if the file specified by RemoteFile exists on the remote server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool CheckFileExists();

Unicode (Windows)
INT CheckFileExists();

bool ipworkssftp_sftpclient_checkfileexists(void* lpObj);

bool CheckFileExists();

Remarks

This property returns true if the file exists on the remote server. It returns false if the file does not exist. You must specify the file you wish to check by setting the RemoteFile before calling this method.

If no session is in place, the value of this property will always be false.

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 (SFTPClient 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* ipworkssftp_sftpclient_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 (SFTPClient Class)

Connects to the Secure Shell (SSH) host without logging in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworkssftp_sftpclient_connect(void* lpObj);

int Connect();

Remarks

This method establishes a connection with the SSHHost but does not log in. In most cases, it is recommended to use the SSHLogon 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 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.)

CreateFile Method (SFTPClient Class)

Creates a file on the Secure File Transfer Protocol (SFTP) server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT CreateFile(LPCWSTR lpszFileName);

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

int CreateFile(const QString& qsFileName);

Remarks

This method creates an empty file on the server with the name specified by the FileName parameter.

To upload a file with content, use Upload instead.

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.)

DecodePacket Method (SFTPClient Class)

Decodes a hex-encoded Secure Shell (SSH) packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DecodePacket(const char* lpszEncodedPacket, int *lpSize = NULL);

Unicode (Windows)
LPSTR DecodePacket(LPCWSTR lpszEncodedPacket, LPINT lpSize = NULL);

char* ipworkssftp_sftpclient_decodepacket(void* lpObj, const char* lpszEncodedPacket, int *lpSize);

QByteArray DecodePacket(const QString& qsEncodedPacket);

Remarks

This method is used to decode an SSH packet created by EncodePacket.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); 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.

DeleteFile Method (SFTPClient Class)

Delete a file specified by FileName from a Secure File Transfer Protocol (SFTP) server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT DeleteFile(LPCWSTR lpszFileName);

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

int DeleteFile(const QString& qsFileName);

Remarks

The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

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 (SFTPClient Class)

Disconnects from the server without first logging off.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworkssftp_sftpclient_disconnect(void* lpObj);

int Disconnect();

Remarks

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

In most cases, the SSHLogoff 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 (SFTPClient Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworkssftp_sftpclient_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 (SFTPClient Class)

Download a RemoteFile from a Secure File Transfer Protocol (SFTP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Download();

Unicode (Windows)
INT Download();

int ipworkssftp_sftpclient_download(void* lpObj);

int Download();

Remarks

The remote file specified by RemoteFile is downloaded 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 is a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

Example. Download a File:

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.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.)

DownloadRange Method (SFTPClient Class)

DownloadRange facilitates the partial downloading of a remote file from a Secure File Transfer Protocol (SFTP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DownloadRange(const char* lpszPath, const char* lpszFileName, int64 lStartByte, int iCount, char** lpBuffer, int lenBuffer);

Unicode (Windows)
INT DownloadRange(LPCWSTR lpszPath, LPCWSTR lpszFileName, LONG64 lStartByte, INT iCount, LPSTR* lpBuffer, INT lenBuffer);

int ipworkssftp_sftpclient_downloadrange(void* lpObj, const char* lpszPath, const char* lpszFileName, int64 lStartByte, int iCount, char** lpBuffer, int lenBuffer);

int DownloadRange(const QString& qsPath, const QString& qsFileName, qint64 lStartByte, int iCount, QByteArray qbaBuffer);

Remarks

This method enables downloading a specific segment of a remote file specified by Path and FileName. StartByte is the offset (in bytes) relative to the beginning of the file from where to start reading, and Count is the number of bytes to read into the specified Buffer.

This functionality is particularly useful for efficient management of large files and targeted data retrieval within them.

Note: If the requested range extends beyond the end of the file, only the available bytes will be returned.

Error Handling (C++)

This method returns an Integer 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.

EncodePacket Method (SFTPClient Class)

Hex encodes a Secure Shell (SSH) packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* EncodePacket(const char* lpPacket, int lenPacket);

Unicode (Windows)
LPWSTR EncodePacket(LPCSTR lpPacket, INT lenPacket);

char* ipworkssftp_sftpclient_encodepacket(void* lpObj, const char* lpPacket, int lenPacket);

QString EncodePacket(QByteArray qbaPacket);

Remarks

This method is used to encode a raw SSH packet created by SetSSHParam.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

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.

GetSSHParam Method (SFTPClient Class)

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHParam(const char* lpPayload, int lenPayload, const char* lpszField);

Unicode (Windows)
LPWSTR GetSSHParam(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszField);

char* ipworkssftp_sftpclient_getsshparam(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszField);

QString GetSSHParam(QByteArray qbaPayload, const QString& qsField);

Remarks

This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as SSHChannelRequest. Field is the name of a field to be read out of the packet.

The following is a list of the names of well-known channel request field names and their encodings:

The remaining fields that are available in the payload are dependent on the value of RequestType.

pty-req

Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:

x11-req

X11-req is a request to forward x11 sessions over a channel. The following fields are available:

env

Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:

exec

Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:

subsystem

Subsystem is a request to start a subsystem on the specified channel. The following field is available:

xon-xoff

Xon-xoff instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:

signal

Sends a signal to the remote process/service. The following field is available:

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".

Note: The return value is a string encoded the same way as the FieldValue param in SetSSHParam.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

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.

GetSSHParamBytes Method (SFTPClient Class)

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHParamBytes(const char* lpPayload, int lenPayload, const char* lpszField, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetSSHParamBytes(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszField, LPINT lpSize = NULL);

char* ipworkssftp_sftpclient_getsshparambytes(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszField, int *lpSize);

QByteArray GetSSHParamBytes(QByteArray qbaPayload, const QString& qsField);

Remarks

This method is the same as calling GetSSHParam, but it returns raw bytes instead of strings.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); 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.

Interrupt Method (SFTPClient Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworkssftp_sftpclient_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 (SFTPClient Class)

List the current directory specified by RemotePath on a Secure File Transfer Protocol (SFTP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListDirectory();

Unicode (Windows)
INT ListDirectory();

int ipworkssftp_sftpclient_listdirectory(void* lpObj);

int ListDirectory();

Remarks

A listing is requested for the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server or is a path relative to RemotePath. The file listing is received through the DirList event.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

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 (SFTPClient Class)

Creates a directory on a Secure File Transfer Protocol (SFTP) server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT MakeDirectory(LPCWSTR lpszNewDir);

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

int MakeDirectory(const QString& qsNewDir);

Remarks

A directory with a path specified by NewDir is created on the SFTP server. NewDir is either an absolute path on the server or is a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

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.)

QueryFileAttributes Method (SFTPClient Class)

Queries the server for the attributes of RemoteFile .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int QueryFileAttributes();

Unicode (Windows)
INT QueryFileAttributes();

int ipworkssftp_sftpclient_queryfileattributes(void* lpObj);

int QueryFileAttributes();

Remarks

This method queries the server for attributes of RemoteFile. After calling this method, FileAttributes will be populated with the values returned by the server.

To update attributes, modify the desired values in FileAttributes and call UpdateFileAttributes.

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.)

QueueFile Method (SFTPClient Class)

Adds a file to the transfer queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int QueueFile(const char* lpszLocalFile, const char* lpszRemoteFile);

Unicode (Windows)
INT QueueFile(LPCWSTR lpszLocalFile, LPCWSTR lpszRemoteFile);

int ipworkssftp_sftpclient_queuefile(void* lpObj, const char* lpszLocalFile, const char* lpszRemoteFile);

int QueueFile(const QString& qsLocalFile, const QString& qsRemoteFile);

Remarks

This method adds a file to the queue of files that will be transferred.

It is not required to use this method; however, this method extends the ability of the class to allow for multiple simultaneous file transfers.

To simply transfer a file without using this method, you need only to set LocalFile and RemoteFile and to call Upload or Download, as appropriate. This method allows you to instead queue multiple files before beginning a transfer.

When a file is queued, it will not be transferred until the Upload or Download method is called. If multiple files are queued, the files will be transferred simultaneously. The SimultaneousTransferLimit setting controls the maximum number of simultaneous transfers.

The Upload or Download method will not return until the queue has been completely processed. This method may be called from within events to add additional files to the queue before processing is complete.

To clear the queue, call ResetQueue. This will not affect current transfers.

To cancel an individual file transfer, set the Cancel parameter of the Transfer event to True. The rest of the queue will continue to process as normal.

The Interrupt method may be called to immediately stop all current transfers.

In the event of a file-specific error, the Error event will fire and the LocalFile and RemoteFile event parameters can be used to identify the file to which the error applies.

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.)

RemoveDirectory Method (SFTPClient Class)

Remove a directory specified by DirName from a secure file transfer protocol (SFTP) server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT RemoveDirectory(LPCWSTR lpszDirName);

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

int RemoveDirectory(const QString& qsDirName);

Remarks

A directory with a path specified by DirName is deleted on the SFTP server. DirName is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

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 (SFTPClient Class)

Change 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 ipworkssftp_sftpclient_renamefile(void* lpObj, const char* lpszNewName);

int RenameFile(const QString& qsNewName);

Remarks

The name of the remote file or the folder specified by RemoteFile is changed to NewName. RemoteFile and NewName are either absolute paths on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

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 (SFTPClient Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkssftp_sftpclient_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.)

ResetQueue Method (SFTPClient Class)

Resets the queue of files to be transferred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetQueue();

Unicode (Windows)
INT ResetQueue();

int ipworkssftp_sftpclient_resetqueue(void* lpObj);

int ResetQueue();

Remarks

This method will remove all files from the transfer queue.

Calling this method will clear all files that were queued by QueueFile. Calling this method will not affect current transfers.

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 (SFTPClient Class)

Sets the stream to which the downloaded data from the server will be written.

Syntax

• C++
• C
• Qt

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

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

int ipworkssftp_sftpclient_setdownloadstream(void* lpObj, IPWorksSFTPStream* sDownloadStream);

int SetDownloadStream(IPWorksSFTPStream* sDownloadStream);

Remarks

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 will need to call SetDownloadStream again before calling Download again.

The downloaded content will be written starting at the current position in the stream.

Note: SetDownloadStream and LocalFile will reset the other.

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.)

SetSSHParam Method (SFTPClient Class)

Writes a field to the end of a payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SetSSHParam(const char* lpPayload, int lenPayload, const char* lpszFieldType, const char* lpszFieldValue, int *lpSize = NULL);

Unicode (Windows)
LPSTR SetSSHParam(LPCSTR lpPayload, INT lenPayload, LPCWSTR lpszFieldType, LPCWSTR lpszFieldValue, LPINT lpSize = NULL);

char* ipworkssftp_sftpclient_setsshparam(void* lpObj, const char* lpPayload, int lenPayload, const char* lpszFieldType, const char* lpszFieldValue, int *lpSize);

QByteArray SetSSHParam(QByteArray qbaPayload, const QString& qsFieldType, const QString& qsFieldValue);

Remarks

This method is used to build the payload portion of a Secure Shell (SSH) packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

The following is a list of supported field types and a description of how FieldValue should be encoded:

Note: Integer values may be hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); 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.

SetUploadStream Method (SFTPClient Class)

Sets the stream from which the class will read data to upload to the server.

Syntax

• C++
• C
• Qt

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

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

int ipworkssftp_sftpclient_setuploadstream(void* lpObj, IPWorksSFTPStream* sUploadStream);

int SetUploadStream(IPWorksSFTPStream* sUploadStream);

Remarks

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 will 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.

Note: SetUploadStream and LocalFile will reset the other.

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.)

SSHLogoff Method (SFTPClient Class)

Logs off from the Secure Shell (SSH) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SSHLogoff();

Unicode (Windows)
INT SSHLogoff();

int ipworkssftp_sftpclient_sshlogoff(void* lpObj);

int SSHLogoff();

Remarks

Logs off from the SSH server. 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.)

SSHLogon Method (SFTPClient Class)

Logs on to the SSHHost using the current SSHUser and SSHPassword .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SSHLogon(const char* lpszSSHHost, int iSSHPort);

Unicode (Windows)
INT SSHLogon(LPCWSTR lpszSSHHost, INT iSSHPort);

int ipworkssftp_sftpclient_sshlogon(void* lpObj, const char* lpszSSHHost, int iSSHPort);

int SSHLogon(const QString& qsSSHHost, int iSSHPort);

Remarks

Logs on to the Secure Shell (SSH) server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example. Logging On:

SSHClient.SSHUser = "username" SSHClient.SSHPassword = "password" SSHClient.SSHLogon("sshHost", sshPort)

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.)

UpdateFileAttributes Method (SFTPClient Class)

Instructs the class to send the FileAttributes to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateFileAttributes();

Unicode (Windows)
INT UpdateFileAttributes();

int ipworkssftp_sftpclient_updatefileattributes(void* lpObj);

int UpdateFileAttributes();

Remarks

When UpdateFileAttributes is called, the class will send the values of the following properties to the server:

• AccessTime
• ACL
• AllocationSize
• AttributeBits
• AttributeBitsValid
• CreationTime
• FileType
• GroupId
• IsDir
• ModifiedTime
• OwnerId
• Permissions
• Size

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 (SFTPClient Class)

Upload a file specified by LocalFile to a secure file transfer protocol (SFTP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Upload();

Unicode (Windows)
INT Upload();

int ipworkssftp_sftpclient_upload(void* lpObj);

int Upload();

Remarks

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

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

Example. 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.)

UploadRange Method (SFTPClient Class)

UploadRange inserts data into a remote file on a secure file transfer protocol (SFTP) server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UploadRange(const char* lpszPath, const char* lpszFileName, int64 lStartByte, int iCount, const char* lpBuffer, int lenBuffer);

Unicode (Windows)
INT UploadRange(LPCWSTR lpszPath, LPCWSTR lpszFileName, LONG64 lStartByte, INT iCount, LPCSTR lpBuffer, INT lenBuffer);

int ipworkssftp_sftpclient_uploadrange(void* lpObj, const char* lpszPath, const char* lpszFileName, int64 lStartByte, int iCount, const char* lpBuffer, int lenBuffer);

int UploadRange(const QString& qsPath, const QString& qsFileName, qint64 lStartByte, int iCount, QByteArray qbaBuffer);

Remarks

This method enables uploading a buffer into the remote file specified by the Path and FileName. Count bytes will be updated from the provided Buffer starting in the remote file at the StartByte offset.

This functionality enables precise control over the insertion of data into a remote file, allowing for targeted modifications, overwriting, or additions starting from a specific position within the file.

Note: If the offset specified is beyond the file length, empty bytes will be created between the last file byte and the uploaded buffer.

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.)

Connected Event (SFTPClient Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(SFTPClientConnectedEventParams *e);

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


Unicode (Windows)
virtual INT FireConnected(SFTPClientConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SFTPClientConnectedEventParams;

#define EID_SFTPCLIENT_CONNECTED 1

virtual INT IPWORKSSFTP_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class SFTPClientConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SFTPClient and override this emitter function.
virtual int FireConnected(SFTPClientConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SFTPClient Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SFTPCLIENT_CONNECTIONSTATUS 2

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

class SFTPClientConnectionStatusEventParams {
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(SFTPClientConnectionStatusEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireConnectionStatus(SFTPClientConnectionStatusEventParams *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 (SFTPClient Class)

Fired when a directory entry is received.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SFTPCLIENT_DIRLIST 3

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

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

  const QString &FileName();

  bool IsDir();

  qint64 FileSize();

  const QString &FileTime();

  bool IsSymlink();

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

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

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

Remarks

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

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

The DirEntry parameter contains the filename when ListDirectory is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectory method.

The format of the FileTime parameter returned by the class can be controlled through the FileTimeFormat configuration setting. If no format is specified, the class will format the date dependent on the year. If the filetime is in the same year, it will be formatted as "MMM dd HH:mm"; otherwise, it will be formatted as "MMM dd yyyy".

IsSymlink indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of IsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the IsDir field.

Disconnected Event (SFTPClient Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(SFTPClientDisconnectedEventParams *e);

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


Unicode (Windows)
virtual INT FireDisconnected(SFTPClientDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SFTPClientDisconnectedEventParams;

#define EID_SFTPCLIENT_DISCONNECTED 4

virtual INT IPWORKSSFTP_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class SFTPClientDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SFTPClient and override this emitter function.
virtual int FireDisconnected(SFTPClientDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (SFTPClient Class)

Fired when a file completes downloading or uploading.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  const char *LocalFile;
  const char *RemoteFile;
  int reserved;
} SFTPClientEndTransferEventParams;


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

typedef struct {
  INT Direction;
  LPCWSTR LocalFile;
  LPCWSTR RemoteFile;
  INT reserved;
} SFTPClientEndTransferEventParams;

#define EID_SFTPCLIENT_ENDTRANSFER 5

virtual INT IPWORKSSFTP_CALL FireEndTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszRemoteFile);

class SFTPClientEndTransferEventParams {
public:
  int Direction();

  const QString &LocalFile();

  const QString &RemoteFile();

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

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

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

Remarks

The EndTransfer event fires when either an upload or a download operation completes. 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.

LocalFile identifies the local file. RemoteFile is the remote file.

Error Event (SFTPClient Class)

Fired when errors occur during data delivery.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ErrorCode;
  const char *Description;
  const char *LocalFile;
  const char *RemoteFile;
  int reserved;
} SFTPClientErrorEventParams;


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

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  LPCWSTR LocalFile;
  LPCWSTR RemoteFile;
  INT reserved;
} SFTPClientErrorEventParams;

#define EID_SFTPCLIENT_ERROR 6

virtual INT IPWORKSSFTP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription, LPSTR &lpszLocalFile, LPSTR &lpszRemoteFile);

class SFTPClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  const QString &LocalFile();

  const QString &RemoteFile();

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

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

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

Remarks

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

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

LocalFile identifies the local file. RemoteFile is the remote file.

Log Event (SFTPClient Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(SFTPClientLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} SFTPClientLogEventParams;


Unicode (Windows)
virtual INT FireLog(SFTPClientLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} SFTPClientLogEventParams;

#define EID_SFTPCLIENT_LOG 7

virtual INT IPWORKSSFTP_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class SFTPClientLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

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

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

// Or, subclass SFTPClient and override this emitter function.
virtual int FireLog(SFTPClientLogEventParams *e) {...}

Remarks

Fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are as follows:

Message is the log message.

LogType is reserved for future use.

SSHCustomAuth Event (SFTPClient Class)

Fired when the class is doing a custom authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHCustomAuth(SFTPClientSSHCustomAuthEventParams *e);

typedef struct {
  char *Packet;
  int reserved;
} SFTPClientSSHCustomAuthEventParams;


Unicode (Windows)
virtual INT FireSSHCustomAuth(SFTPClientSSHCustomAuthEventParams *e);

typedef struct {
  LPWSTR Packet;
  INT reserved;
} SFTPClientSSHCustomAuthEventParams;

#define EID_SFTPCLIENT_SSHCUSTOMAUTH 8

virtual INT IPWORKSSFTP_CALL FireSSHCustomAuth(LPSTR &lpszPacket);

class SFTPClientSSHCustomAuthEventParams {
public:
  const QString &Packet();
  void SetPacket(const QString &qsPacket);

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

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

// Or, subclass SFTPClient and override this emitter function.
virtual int FireSSHCustomAuth(SFTPClientSSHCustomAuthEventParams *e) {...}

Remarks

SSHCustomAuth is fired during the user authentication stage of the Secure Shell (SSH) logon process if SSHAuthMode is set to amCustom. Packet contains the last raw SSH packet sent by the server, in HEX-encoded format.

The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.

In all cases, Packet will start with the message type field.

To read the incoming packet, call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet, use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (SFTPClient Class)

Fired when the class receives a request for user input from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHKeyboardInteractive(SFTPClientSSHKeyboardInteractiveEventParams *e);

typedef struct {
  const char *Name;
  const char *Instructions;
  const char *Prompt;
  char *Response;
  int EchoResponse;
  int reserved;
} SFTPClientSSHKeyboardInteractiveEventParams;


Unicode (Windows)
virtual INT FireSSHKeyboardInteractive(SFTPClientSSHKeyboardInteractiveEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Instructions;
  LPCWSTR Prompt;
  LPWSTR Response;
  BOOL EchoResponse;
  INT reserved;
} SFTPClientSSHKeyboardInteractiveEventParams;

#define EID_SFTPCLIENT_SSHKEYBOARDINTERACTIVE 9

virtual INT IPWORKSSFTP_CALL FireSSHKeyboardInteractive(LPSTR &lpszName, LPSTR &lpszInstructions, LPSTR &lpszPrompt, LPSTR &lpszResponse, BOOL &bEchoResponse);

class SFTPClientSSHKeyboardInteractiveEventParams {
public:
  const QString &Name();

  const QString &Instructions();

  const QString &Prompt();

  const QString &Response();
  void SetResponse(const QString &qsResponse);

  bool EchoResponse();

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

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

// Or, subclass SFTPClient and override this emitter function.
virtual int FireSSHKeyboardInteractive(SFTPClientSSHKeyboardInteractiveEventParams *e) {...}

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the class will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the class will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

Note: The server may send several prompts in a single packet. The class will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SFTPClient Class)

Fired after the server presents its public key to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHServerAuthentication(SFTPClientSSHServerAuthenticationEventParams *e);

typedef struct {
  const char *HostKey;
  int lenHostKey;
  const char *Fingerprint;
  const char *KeyAlgorithm;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SFTPClientSSHServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSHServerAuthentication(SFTPClientSSHServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR HostKey;
  INT lenHostKey;
  LPCWSTR Fingerprint;
  LPCWSTR KeyAlgorithm;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SFTPClientSSHServerAuthenticationEventParams;

#define EID_SFTPCLIENT_SSHSERVERAUTHENTICATION 10

virtual INT IPWORKSSFTP_CALL FireSSHServerAuthentication(LPSTR &lpHostKey, INT &lenHostKey, LPSTR &lpszFingerprint, LPSTR &lpszKeyAlgorithm, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SFTPClientSSHServerAuthenticationEventParams {
public:
  const QByteArray &HostKey();

  const QString &Fingerprint();

  const QString &KeyAlgorithm();

  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 SSHServerAuthentication(SFTPClientSSHServerAuthenticationEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireSSHServerAuthentication(SFTPClientSSHServerAuthenticationEventParams *e) {...}

Remarks

This event is fired when the client can decide whether or not to continue with the connection process. If the public key is known to be a valid key for the Secure Shell (SSH) server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.

Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.

Accept may be set to True manually to accept the server host key.

Note: SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to True is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.

Host Key contains the full binary text of the key, in the same format used internally by SSH.

Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value, see SSHFingerprintHashAlgorithm.

KeyAlgorithm identifies the host key algorithm. The following values are supported:

• ssh-rsa
• ssh-dss
• rsa-sha2-256
• rsa-sha2-512
• x509v3-sign-rsa
• x509v3-sign-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521

CertSubject is the subject of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

SSHStatus Event (SFTPClient Class)

Fired to track the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHStatus(SFTPClientSSHStatusEventParams *e);

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


Unicode (Windows)
virtual INT FireSSHStatus(SFTPClientSSHStatusEventParams *e);

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

#define EID_SFTPCLIENT_SSHSTATUS 11

virtual INT IPWORKSSFTP_CALL FireSSHStatus(LPSTR &lpszMessage);

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

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

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

// Or, subclass SFTPClient and override this emitter function.
virtual int FireSSHStatus(SFTPClientSSHStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (SFTPClient Class)

Fired when a file starts downloading or uploading.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  const char *LocalFile;
  const char *RemoteFile;
  int reserved;
} SFTPClientStartTransferEventParams;


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

typedef struct {
  INT Direction;
  LPCWSTR LocalFile;
  LPCWSTR RemoteFile;
  INT reserved;
} SFTPClientStartTransferEventParams;

#define EID_SFTPCLIENT_STARTTRANSFER 12

virtual INT IPWORKSSFTP_CALL FireStartTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszRemoteFile);

class SFTPClientStartTransferEventParams {
public:
  int Direction();

  const QString &LocalFile();

  const QString &RemoteFile();

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

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

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

Remarks

The StartTransfer event fires when a data interface connection is created. This occurs 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.

LocalFile identifies the local file. RemoteFile is the remote file.

Transfer Event (SFTPClient Class)

Fired during file download or upload.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  const char *LocalFile;
  const char *RemoteFile;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int Cancel;
  int reserved;
} SFTPClientTransferEventParams;


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

typedef struct {
  INT Direction;
  LPCWSTR LocalFile;
  LPCWSTR RemoteFile;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  BOOL Cancel;
  INT reserved;
} SFTPClientTransferEventParams;

#define EID_SFTPCLIENT_TRANSFER 13

virtual INT IPWORKSSFTP_CALL FireTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszRemoteFile, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText, BOOL &bCancel);

class SFTPClientTransferEventParams {
public:
  int Direction();

  const QString &LocalFile();

  const QString &RemoteFile();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  bool Cancel();
  void SetCancel(bool bCancel);

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

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

// Or, subclass SFTPClient and override this emitter function.
virtual int FireTransfer(SFTPClientTransferEventParams *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.

LocalFile identifies the local file. RemoteFile is the remote file.

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

To cancel the current transfer, set Cancel to True.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksSFTPCertificate (declared in ipworkssftp.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

IPWorksSFTPDirEntry (declared in ipworkssftp.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

IPWorksSFTPFirewall (declared in ipworkssftp.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()

SFTPFileAttributes Type

Includes a set of attributes for a file existing on an secure file transfer protocol (SFTP) server.

Syntax

IPWorksSFTPSFTPFileAttributes (declared in ipworkssftp.h)

Remarks

This type describes a file residing on an SFTP server.

Fields

IPWorksSFTPList Type

Syntax

IPWorksSFTPList<T> (declared in ipworkssftp.h)

Remarks

IPWorksSFTPList 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 SFTPClient class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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

IPWorksSFTPStream Type

Syntax

IPWorksSFTPStream (declared in ipworkssftp.h)

Remarks

The SFTPClient 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 IPWorksSFTPStream interface and pass the SFTPClient class an instance of that concrete class.

When implementing the IPWorksSFTPStream 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 (SFTPClient Class)

SFTPClient Config Settings

SSHClient Config Settings