OFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The OFTPClient class implements the Odette File Transfer Protocol.

Syntax

OFTPClient

Remarks

The OFTPClient component may be used to send and receive OFTP files to and from an OFTP server.

Receiving Files

The OFTPClient ReceiveFiles function requires certain server properties be set. You must set the RemoteHost property to the remote location of the desired OFTP server. You may also set a RemotePort if the server is not set to the default protocol port. For client authorization, you must set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties. And, for server authentication, you must set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties.

The class will connect to the OFTP server and download all files in the server's outgoing queue, and write these files to the directory specified by DownloadDirectory. The class creates a default location on the local machine based on the values of the DownloadDirectory and the Virtual Filename as received from the server. If a different location is preferred, you may set the LocalFile parameter of the StartTransfer event.

Sending Files

The OFTPClient SendFile function requires the same server and authentication properties to be set as the ReceiveFiles function.

The class will connect to the OFTP server and upload the file contained by the LocalFile parameter. It uses the name specified by VirtualFileName when sending to the server. If this is not specified, the filename of the local file is parsed and used as the virtual filename.

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.

Certificate Property (OFTPClient Class)

The current selected certificate.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetCertificate();
int SetCertificate(IPWorksEDICertificate* val);

int ipworksedi_oftpclient_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksedi_oftpclient_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

char* ipworksedi_oftpclient_getcertstorepassword(void* lpObj);
int ipworksedi_oftpclient_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

int ipworksedi_oftpclient_getcertstoretype(void* lpObj);
int ipworksedi_oftpclient_setcertstoretype(void* lpObj, int iCertStoreType);

char* ipworksedi_oftpclient_getcertsubject(void* lpObj);
int ipworksedi_oftpclient_setcertsubject(void* lpObj, const char* lpszCertSubject);

int ipworksedi_oftpclient_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksedi_oftpclient_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Remarks

This property is populated when a specified certificate is found or loaded by the class. Certificate is used for specifying private keys. Set this property to a valid Certificate object to perform different operations such as session authentication, signing a file or receipt, or decryption. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the Store and Subject fields.

Data Type

IPWorksEDICertificate

ClientPassword Property (OFTPClient Class)

The client's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientPassword();
int SetClientPassword(const char* lpszClientPassword);

Unicode (Windows)
LPWSTR GetClientPassword();
INT SetClientPassword(LPCWSTR lpszClientPassword);

char* ipworksedi_oftpclient_getclientpassword(void* lpObj);
int ipworksedi_oftpclient_setclientpassword(void* lpObj, const char* lpszClientPassword);

QString GetClientPassword();
int SetClientPassword(QString qsClientPassword);

Default Value

""

Remarks

The password assigned to the client in the bilateral agreement. This property must be a string of no more than 8 characters long.

Data Type

String

ClientSFIDCode Property (OFTPClient Class)

Client's SFID code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientSFIDCode();
int SetClientSFIDCode(const char* lpszClientSFIDCode);

Unicode (Windows)
LPWSTR GetClientSFIDCode();
INT SetClientSFIDCode(LPCWSTR lpszClientSFIDCode);

char* ipworksedi_oftpclient_getclientsfidcode(void* lpObj);
int ipworksedi_oftpclient_setclientsfidcode(void* lpObj, const char* lpszClientSFIDCode);

QString GetClientSFIDCode();
int SetClientSFIDCode(QString qsClientSFIDCode);

Default Value

""

Remarks

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

Data Type

String

ClientSSIDCode Property (OFTPClient Class)

The client's SSID code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientSSIDCode();
int SetClientSSIDCode(const char* lpszClientSSIDCode);

Unicode (Windows)
LPWSTR GetClientSSIDCode();
INT SetClientSSIDCode(LPCWSTR lpszClientSSIDCode);

char* ipworksedi_oftpclient_getclientssidcode(void* lpObj);
int ipworksedi_oftpclient_setclientssidcode(void* lpObj, const char* lpszClientSSIDCode);

QString GetClientSSIDCode();
int SetClientSSIDCode(QString qsClientSSIDCode);

Default Value

""

Remarks

The identification code of the client. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:

Data Type

String

Compress Property (OFTPClient Class)

Whether or not to compress the outgoing file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompress();
int SetCompress(int bCompress);

Unicode (Windows)
BOOL GetCompress();
INT SetCompress(BOOL bCompress);

int ipworksedi_oftpclient_getcompress(void* lpObj);
int ipworksedi_oftpclient_setcompress(void* lpObj, int bCompress);

bool GetCompress();
int SetCompress(bool bCompress);

Default Value

FALSE

Remarks

When sending a file to the trading partner, set this to true for the class to compress the file before sending. The file will first be compressed to a temporary file before being sent.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by Version.

This property is not available at design time.

Data Type

Boolean

Connected Property (OFTPClient Class)

Shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksedi_oftpclient_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

Use this property to determine whether the class is connected to the remote host or not.

Use the Connect and Disconnect methods to manage the connection.

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

Data Type

Boolean

DownloadDirectory Property (OFTPClient Class)

Download directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDownloadDirectory();
int SetDownloadDirectory(const char* lpszDownloadDirectory);

Unicode (Windows)
LPWSTR GetDownloadDirectory();
INT SetDownloadDirectory(LPCWSTR lpszDownloadDirectory);

char* ipworksedi_oftpclient_getdownloaddirectory(void* lpObj);
int ipworksedi_oftpclient_setdownloaddirectory(void* lpObj, const char* lpszDownloadDirectory);

QString GetDownloadDirectory();
int SetDownloadDirectory(QString qsDownloadDirectory);

Default Value

"./"

Remarks

This property contains the location on disk of the folder the class will write received files to. The default for this property is "./", which is the current working directory.

Note: If this property is set to empty string data will not be written to disk and instead will be available through the Transfer event.

Data Type

String

EncryptionAlgorithm Property (OFTPClient Class)

The encryption algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

ENCRA_3DES(0), 
ENCRA_AES(1)

int ipworksedi_oftpclient_getencryptionalgorithm(void* lpObj);
int ipworksedi_oftpclient_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

0

Remarks

In order to use encryption, you must set the VirtualFileSecurityLevel property. The supported algorithms for encryption are:

This property is not available at design time.

Data Type

Integer

Firewall Property (OFTPClient Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int ipworksedi_oftpclient_getfirewallautodetect(void* lpObj);
int ipworksedi_oftpclient_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksedi_oftpclient_getfirewalltype(void* lpObj);
int ipworksedi_oftpclient_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksedi_oftpclient_getfirewallhost(void* lpObj);
int ipworksedi_oftpclient_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksedi_oftpclient_getfirewallpassword(void* lpObj);
int ipworksedi_oftpclient_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksedi_oftpclient_getfirewallport(void* lpObj);
int ipworksedi_oftpclient_setfirewallport(void* lpObj, int iFirewallPort);

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

IPWorksEDIFirewall

LocalHost Property (OFTPClient 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* ipworksedi_oftpclient_getlocalhost(void* lpObj);
int ipworksedi_oftpclient_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

MaxRecordSize Property (OFTPClient Class)

The maximum length of a given record.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMaxRecordSize();
int SetMaxRecordSize(int iMaxRecordSize);

Unicode (Windows)
INT GetMaxRecordSize();
INT SetMaxRecordSize(INT iMaxRecordSize);

int ipworksedi_oftpclient_getmaxrecordsize(void* lpObj);
int ipworksedi_oftpclient_setmaxrecordsize(void* lpObj, int iMaxRecordSize);

int GetMaxRecordSize();
int SetMaxRecordSize(int iMaxRecordSize);

Default Value

0

Remarks

This value determines the maximum length for a record in the outgoing virtual file. When VirtualFileFormat has been set to ffUnstructured or ffText, this value must be zero. When ffFixed or ffVariable, this must be set to a value greater than 0, containing the maximum line length of the outgoing file.

Data Type

Integer

Overwrite Property (OFTPClient Class)

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 ipworksedi_oftpclient_getoverwrite(void* lpObj);
int ipworksedi_oftpclient_setoverwrite(void* lpObj, int bOverwrite);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

RecipientCert Property (OFTPClient Class)

The recipient certificate of the message.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetRecipientCert();
int SetRecipientCert(IPWorksEDICertificate* val);

int ipworksedi_oftpclient_getrecipientcertstore(void* lpObj, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworksedi_oftpclient_setrecipientcertstore(void* lpObj, const char* lpRecipientCertStore, int lenRecipientCertStore);

char* ipworksedi_oftpclient_getrecipientcertstorepassword(void* lpObj);
int ipworksedi_oftpclient_setrecipientcertstorepassword(void* lpObj, const char* lpszRecipientCertStorePassword);

int ipworksedi_oftpclient_getrecipientcertstoretype(void* lpObj);
int ipworksedi_oftpclient_setrecipientcertstoretype(void* lpObj, int iRecipientCertStoreType);

char* ipworksedi_oftpclient_getrecipientcertsubject(void* lpObj);
int ipworksedi_oftpclient_setrecipientcertsubject(void* lpObj, const char* lpszRecipientCertSubject);

int ipworksedi_oftpclient_getrecipientcertencoded(void* lpObj, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksedi_oftpclient_setrecipientcertencoded(void* lpObj, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

QByteArray GetRecipientCertStore();
int SetRecipientCertStore(QByteArray qbaRecipientCertStore);

QString GetRecipientCertStorePassword();
int SetRecipientCertStorePassword(QString qsRecipientCertStorePassword);

int GetRecipientCertStoreType();
int SetRecipientCertStoreType(int iRecipientCertStoreType);

QString GetRecipientCertSubject();
int SetRecipientCertSubject(QString qsRecipientCertSubject);

QByteArray GetRecipientCertEncoded();
int SetRecipientCertEncoded(QByteArray qbaRecipientCertEncoded);

Remarks

This property specifies the certificate to use when verifying signed files and receipts as well as encrypting files to be sent. This property must be set when SecureAuthentication has been set to true, sending a file and VirtualFileSecurityLevel has been set to slEncrypted or slEncryptedAndSigned, SignedReceipt has been set to true, or a signed file is being received and the server has not included the certificate in the signature.

The RecipientCert property must be filled out with a valid public key Certificate type object. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the Store and Subject fields.

This property is not available at design time.

Data Type

IPWorksEDICertificate

RemoteHost Property (OFTPClient Class)

The domain name or IP address of the OFTP server.

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_oftpclient_getremotehost(void* lpObj);
int ipworksedi_oftpclient_setremotehost(void* lpObj, const char* lpszRemoteHost);

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

Default Value

""

Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the OFTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

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

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

Data Type

String

RemotePort Property (OFTPClient Class)

The port for the OFTP service (default is 3305).

Syntax

• C++
• C
• Qt

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

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

int ipworksedi_oftpclient_getremoteport(void* lpObj);
int ipworksedi_oftpclient_setremoteport(void* lpObj, int iRemotePort);

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

Default Value

3305

Remarks

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.

When UseSSL is set to True this property will be set to 6619.

This property is not available at design time.

Data Type

Integer

SecureAuthentication Property (OFTPClient Class)

Whether or not the class should perform secure Odette authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecureAuthentication();
int SetSecureAuthentication(int bSecureAuthentication);

Unicode (Windows)
BOOL GetSecureAuthentication();
INT SetSecureAuthentication(BOOL bSecureAuthentication);

int ipworksedi_oftpclient_getsecureauthentication(void* lpObj);
int ipworksedi_oftpclient_setsecureauthentication(void* lpObj, int bSecureAuthentication);

bool GetSecureAuthentication();
int SetSecureAuthentication(bool bSecureAuthentication);

Default Value

FALSE

Remarks

If true, the class will perform secure authentication when connecting to the server. The secure authentication consists of encrypting and decrypting data sent to and from the server, and verifying that this occurred successfully. Secure authentication may be performed in plaintext or SSL mode.

Both Certificate and RecipientCert properties must be populated when this property is set to true.

This is only valid for version 2.0 of the protocol.

This property is not available at design time.

Data Type

Boolean

ServerPassword Property (OFTPClient Class)

The server's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerPassword();
int SetServerPassword(const char* lpszServerPassword);

Unicode (Windows)
LPWSTR GetServerPassword();
INT SetServerPassword(LPCWSTR lpszServerPassword);

char* ipworksedi_oftpclient_getserverpassword(void* lpObj);
int ipworksedi_oftpclient_setserverpassword(void* lpObj, const char* lpszServerPassword);

QString GetServerPassword();
int SetServerPassword(QString qsServerPassword);

Default Value

""

Remarks

The password assigned to the server in the bilateral agreement. This property must be a string of no more than 8 characters long.

Data Type

String

ServerSFIDCode Property (OFTPClient Class)

Server's SFID code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerSFIDCode();
int SetServerSFIDCode(const char* lpszServerSFIDCode);

Unicode (Windows)
LPWSTR GetServerSFIDCode();
INT SetServerSFIDCode(LPCWSTR lpszServerSFIDCode);

char* ipworksedi_oftpclient_getserversfidcode(void* lpObj);
int ipworksedi_oftpclient_setserversfidcode(void* lpObj, const char* lpszServerSFIDCode);

QString GetServerSFIDCode();
int SetServerSFIDCode(QString qsServerSFIDCode);

Default Value

""

Remarks

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

Data Type

String

ServerSSIDCode Property (OFTPClient Class)

The server's SSID code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerSSIDCode();
int SetServerSSIDCode(const char* lpszServerSSIDCode);

Unicode (Windows)
LPWSTR GetServerSSIDCode();
INT SetServerSSIDCode(LPCWSTR lpszServerSSIDCode);

char* ipworksedi_oftpclient_getserverssidcode(void* lpObj);
int ipworksedi_oftpclient_setserverssidcode(void* lpObj, const char* lpszServerSSIDCode);

QString GetServerSSIDCode();
int SetServerSSIDCode(QString qsServerSSIDCode);

Default Value

""

Remarks

The identification code of the server. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:

Data Type

String

SignedReceipt Property (OFTPClient Class)

Whether or not to require signed receipts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignedReceipt();
int SetSignedReceipt(int bSignedReceipt);

Unicode (Windows)
BOOL GetSignedReceipt();
INT SetSignedReceipt(BOOL bSignedReceipt);

int ipworksedi_oftpclient_getsignedreceipt(void* lpObj);
int ipworksedi_oftpclient_setsignedreceipt(void* lpObj, int bSignedReceipt);

bool GetSignedReceipt();
int SetSignedReceipt(bool bSignedReceipt);

Default Value

FALSE

Remarks

When sending a file to a trading partner, set this to true if the file receipt should be signed by the server. When this receipt is received by the class, it will be verified during processing.

NOTE: If the server does not attach the public certificate in the signed message, the server's public key must be specified in the RecipientCert property in order for verification to succeed.

This property is not available at design time.

Data Type

Boolean

SSLAcceptServerCert Property (OFTPClient Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworksedi_oftpclient_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertissuer(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertprivatekey(void* lpObj);

int ipworksedi_oftpclient_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertpublickey(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksedi_oftpclient_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksedi_oftpclient_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksedi_oftpclient_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksedi_oftpclient_getsslacceptservercertstorepassword(void* lpObj);
int ipworksedi_oftpclient_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksedi_oftpclient_getsslacceptservercertstoretype(void* lpObj);
int ipworksedi_oftpclient_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksedi_oftpclient_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertusage(void* lpObj);

int ipworksedi_oftpclient_getsslacceptservercertusageflags(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertversion(void* lpObj);

char* ipworksedi_oftpclient_getsslacceptservercertsubject(void* lpObj);
int ipworksedi_oftpclient_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksedi_oftpclient_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksedi_oftpclient_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

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

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

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

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

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

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

Remarks

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

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

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

Data Type

IPWorksEDICertificate

SSLCert Property (OFTPClient Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworksedi_oftpclient_getsslcerteffectivedate(void* lpObj);

char* ipworksedi_oftpclient_getsslcertexpirationdate(void* lpObj);

char* ipworksedi_oftpclient_getsslcertextendedkeyusage(void* lpObj);

char* ipworksedi_oftpclient_getsslcertfingerprint(void* lpObj);

char* ipworksedi_oftpclient_getsslcertfingerprintsha1(void* lpObj);

char* ipworksedi_oftpclient_getsslcertfingerprintsha256(void* lpObj);

char* ipworksedi_oftpclient_getsslcertissuer(void* lpObj);

char* ipworksedi_oftpclient_getsslcertprivatekey(void* lpObj);

int ipworksedi_oftpclient_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksedi_oftpclient_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksedi_oftpclient_getsslcertpublickey(void* lpObj);

char* ipworksedi_oftpclient_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksedi_oftpclient_getsslcertpublickeylength(void* lpObj);

char* ipworksedi_oftpclient_getsslcertserialnumber(void* lpObj);

char* ipworksedi_oftpclient_getsslcertsignaturealgorithm(void* lpObj);

int ipworksedi_oftpclient_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_oftpclient_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksedi_oftpclient_getsslcertstorepassword(void* lpObj);
int ipworksedi_oftpclient_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksedi_oftpclient_getsslcertstoretype(void* lpObj);
int ipworksedi_oftpclient_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksedi_oftpclient_getsslcertsubjectaltnames(void* lpObj);

char* ipworksedi_oftpclient_getsslcertthumbprintmd5(void* lpObj);

char* ipworksedi_oftpclient_getsslcertthumbprintsha1(void* lpObj);

char* ipworksedi_oftpclient_getsslcertthumbprintsha256(void* lpObj);

char* ipworksedi_oftpclient_getsslcertusage(void* lpObj);

int ipworksedi_oftpclient_getsslcertusageflags(void* lpObj);

char* ipworksedi_oftpclient_getsslcertversion(void* lpObj);

char* ipworksedi_oftpclient_getsslcertsubject(void* lpObj);
int ipworksedi_oftpclient_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksedi_oftpclient_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_oftpclient_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

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

Data Type

IPWorksEDICertificate

Timeout Property (OFTPClient Class)

This property includes 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 ipworksedi_oftpclient_gettimeout(void* lpObj);
int ipworksedi_oftpclient_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 return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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

TrustedCerts Property (OFTPClient Class)

A collection of trusted CA certificates.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDICertificate>* GetTrustedCerts();
int SetTrustedCerts(IPWorksEDIList<IPWorksEDICertificate>* val);

int ipworksedi_oftpclient_gettrustedcertcount(void* lpObj);
int ipworksedi_oftpclient_settrustedcertcount(void* lpObj, int iTrustedCertCount);

int ipworksedi_oftpclient_gettrustedcertstore(void* lpObj, int trustedcertindex, char** lpTrustedCertStore, int* lenTrustedCertStore);
int ipworksedi_oftpclient_settrustedcertstore(void* lpObj, int trustedcertindex, const char* lpTrustedCertStore, int lenTrustedCertStore);

char* ipworksedi_oftpclient_gettrustedcertstorepassword(void* lpObj, int trustedcertindex);
int ipworksedi_oftpclient_settrustedcertstorepassword(void* lpObj, int trustedcertindex, const char* lpszTrustedCertStorePassword);

int ipworksedi_oftpclient_gettrustedcertstoretype(void* lpObj, int trustedcertindex);
int ipworksedi_oftpclient_settrustedcertstoretype(void* lpObj, int trustedcertindex, int iTrustedCertStoreType);

char* ipworksedi_oftpclient_gettrustedcertsubject(void* lpObj, int trustedcertindex);
int ipworksedi_oftpclient_settrustedcertsubject(void* lpObj, int trustedcertindex, const char* lpszTrustedCertSubject);

int ipworksedi_oftpclient_gettrustedcertencoded(void* lpObj, int trustedcertindex, char** lpTrustedCertEncoded, int* lenTrustedCertEncoded);
int ipworksedi_oftpclient_settrustedcertencoded(void* lpObj, int trustedcertindex, const char* lpTrustedCertEncoded, int lenTrustedCertEncoded);

int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

QByteArray GetTrustedCertStore(int iTrustedCertIndex);
int SetTrustedCertStore(int iTrustedCertIndex, QByteArray qbaTrustedCertStore);

QString GetTrustedCertStorePassword(int iTrustedCertIndex);
int SetTrustedCertStorePassword(int iTrustedCertIndex, QString qsTrustedCertStorePassword);

int GetTrustedCertStoreType(int iTrustedCertIndex);
int SetTrustedCertStoreType(int iTrustedCertIndex, int iTrustedCertStoreType);

QString GetTrustedCertSubject(int iTrustedCertIndex);
int SetTrustedCertSubject(int iTrustedCertIndex, QString qsTrustedCertSubject);

QByteArray GetTrustedCertEncoded(int iTrustedCertIndex);
int SetTrustedCertEncoded(int iTrustedCertIndex, QByteArray qbaTrustedCertEncoded);

Remarks

If this collection is populated the class will validate any certificates that are loaded against the CA certificates specified here.

If this collection is not populated no validation will occur. Certificates are imported into this collection by calling the ImportTrustedCerts method.

See also FailOnUntrustedCert and TrustedCertsData.

This property is not available at design time.

Data Type

IPWorksEDICertificate

UseSSL Property (OFTPClient Class)

Use SSL to access the RemoteHost .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseSSL();
int SetUseSSL(int bUseSSL);

Unicode (Windows)
BOOL GetUseSSL();
INT SetUseSSL(BOOL bUseSSL);

int ipworksedi_oftpclient_getusessl(void* lpObj);
int ipworksedi_oftpclient_setusessl(void* lpObj, int bUseSSL);

bool GetUseSSL();
int SetUseSSL(bool bUseSSL);

Default Value

FALSE

Remarks

Use this property to determine whether the class uses SSL to connect with the RemoteHost.

This property is only valid when using version 2.0 of the protocol.

Note: Setting this property to True will set RemotePort to 6619.

This property is not available at design time.

Data Type

Boolean

Version Property (OFTPClient Class)

Which version of the OFTP protocol the class is using.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVersion();
int SetVersion(int iVersion);

Unicode (Windows)
INT GetVersion();
INT SetVersion(INT iVersion);

OFTP_VER_12(0), 
OFTP_VER_13(1), 
OFTP_VER_14(2), 
OFTP_VER_20(3)

int ipworksedi_oftpclient_getversion(void* lpObj);
int ipworksedi_oftpclient_setversion(void* lpObj, int iVersion);

int GetVersion();
int SetVersion(int iVersion);

Default Value

3

Remarks

This property specifies which version of the OFTP protocol to use. Possible values are:

Note: Version 2.0 (oftpVer20) of the protocol must be used when using security functions. The following properties are only applicable when using Version 2.0:

• UseSSL
• SecureAuthentication
• VirtualFileSecurityLevel
• Compress

Data Type

Integer

VirtualFileDate Property (OFTPClient Class)

The date/time stamp for the virtual file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVirtualFileDate();
int SetVirtualFileDate(const char* lpszVirtualFileDate);

Unicode (Windows)
LPWSTR GetVirtualFileDate();
INT SetVirtualFileDate(LPCWSTR lpszVirtualFileDate);

char* ipworksedi_oftpclient_getvirtualfiledate(void* lpObj);
int ipworksedi_oftpclient_setvirtualfiledate(void* lpObj, const char* lpszVirtualFileDate);

QString GetVirtualFileDate();
int SetVirtualFileDate(QString qsVirtualFileDate);

Default Value

""

Remarks

Set this to the date/time stamp for the virtual file before sending. If this is not set when sending a file, the current date/time will be used. This property will accept various date formats, but will return the following format only: "MM/dd/yyyy HH:mm:ss".

Supported date formats:

• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• d MMM yy HH:mm:ss zzz
• d MMM yyyy HH:mm:ss zzz
• dd-MMM-yyyy HH:mm:ss
• ddd, d MMM yy HH:mm:ss zz
• ddd, d MMM yyyy HH:mm:ss zz
• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• ddd, d MMM yy HH:mm:ss z
• ddd, d MMM yyyy HH:mm:ss z
• ddd, dd MMM yyyy HH:mm:ss 'GMT'
• dddd, MMMM dd, yyyy h:mm:ss tt
• dddd, MMMM dd yyyy h:mm tt
• yyMMddHHmmssZ
• yyyyMMddHHmmssZ
• yyMMddHHmmsszzzz
• yyyyMMddHHmmsszzzz
• yyyyMMddHHmmssffff
• MM/dd/yyyy HH:mm:ss

Data Type

String

VirtualFileFormat Property (OFTPClient Class)

The structure of the outgoing file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVirtualFileFormat();
int SetVirtualFileFormat(int iVirtualFileFormat);

Unicode (Windows)
INT GetVirtualFileFormat();
INT SetVirtualFileFormat(INT iVirtualFileFormat);

FF_UNSTRUCTURED(0), 
FF_TEXT(1), 
FF_FIXED(2), 
FF_VARIABLE(3)

int ipworksedi_oftpclient_getvirtualfileformat(void* lpObj);
int ipworksedi_oftpclient_setvirtualfileformat(void* lpObj, int iVirtualFileFormat);

int GetVirtualFileFormat();
int SetVirtualFileFormat(int iVirtualFileFormat);

Default Value

0

Remarks

The following values are valid file formats for outgoing virtual files:

Note: When either VirtualFileSecurityLevel has been set to a value other than slNone or Compress has been set to true, all files become ffUnstructured except ffVariable files.

This property is not available at design time.

Data Type

Integer

VirtualFileSecurityLevel Property (OFTPClient Class)

The level of security for the file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVirtualFileSecurityLevel();
int SetVirtualFileSecurityLevel(int iVirtualFileSecurityLevel);

Unicode (Windows)
INT GetVirtualFileSecurityLevel();
INT SetVirtualFileSecurityLevel(INT iVirtualFileSecurityLevel);

SL_NONE(0), 
SL_ENCRYPTED(1), 
SL_SIGNED(2), 
SL_ENCRYPTED_AND_SIGNED(3)

int ipworksedi_oftpclient_getvirtualfilesecuritylevel(void* lpObj);
int ipworksedi_oftpclient_setvirtualfilesecuritylevel(void* lpObj, int iVirtualFileSecurityLevel);

int GetVirtualFileSecurityLevel();
int SetVirtualFileSecurityLevel(int iVirtualFileSecurityLevel);

Default Value

0

Remarks

When sending files, set this value to the level of security for the next virtual file to send. After receiving a file, this will be set to the level of security of the last file received.

When encrypting a file, RecipientCert must be set, and when signing a file, the Certificate must be set.

The file will be processed to a temporary file before being sent.

This is only valid for version 2.0 of the protocol.

This property is not available at design time.

Data Type

Integer

ChangeDirection Method (OFTPClient Class)

Sends a Change Direction (CD) command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeDirection();

Unicode (Windows)
INT ChangeDirection();

int ipworksedi_oftpclient_changedirection(void* lpObj);

int ChangeDirection();

Remarks

This method sends a Change Direction (CD) command to the remote host when called. In normal operation this should not be used. This should only be used if a condition arises where you must manually change the speaker when communicating with the remote 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.)

Config Method (OFTPClient 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* ipworksedi_oftpclient_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 (OFTPClient Class)

This method connects to the FTP server without logging in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksedi_oftpclient_connect(void* lpObj);

int Connect();

Remarks

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

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

Error Handling (C++)

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

Disconnect Method (OFTPClient Class)

This method disconnects from the server without first logging off.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksedi_oftpclient_disconnect(void* lpObj);

int Disconnect();

Remarks

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

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

Error Handling (C++)

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

DoEvents Method (OFTPClient Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

ExchangeCertificate Method (OFTPClient Class)

Exchange a certificate with the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExchangeCertificate(const char* lpszCertificateStore, int iCertificateExchangeType);

Unicode (Windows)
INT ExchangeCertificate(LPCWSTR lpszCertificateStore, INT iCertificateExchangeType);

int ipworksedi_oftpclient_exchangecertificate(void* lpObj, const char* lpszCertificateStore, int iCertificateExchangeType);

int ExchangeCertificate(const QString& qsCertificateStore, int iCertificateExchangeType);

Remarks

If the remote host supports the certificate exchange feature of OFTP 2.0 this method may be used to send and/or request certificates.

The CertificateStore parameter specifies the location of the certificate to be exchanged. In most cases this will be the path to a .cer file on disk. If the certificate is in another format or is installed to the Windows certificate store please see ExchangeCertStoreType and ExchangeCertSubject for more information.

The CertificateExchangeType parameter determines the type of request. Possible values are:

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

ImportTrustedCerts Method (OFTPClient Class)

Imports a list of trusted CA certificates.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportTrustedCerts();

Unicode (Windows)
INT ImportTrustedCerts();

int ipworksedi_oftpclient_importtrustedcerts(void* lpObj);

int ImportTrustedCerts();

Remarks

When ImportTrustedCerts is called the class will import the CA certificates from the source specified by TrustedCertsData into the TrustedCerts collection.

The class will then validate the trust of certificates when they are loaded.

If trusted CA certificates are not imported no validation will occur (default).

See also FailOnUntrustedCert.

Error Handling (C++)

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

Interrupt Method (OFTPClient Class)

This method interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksedi_oftpclient_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the 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.)

Logoff Method (OFTPClient Class)

Logoff from the OFTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Logoff();

Unicode (Windows)
INT Logoff();

int ipworksedi_oftpclient_logoff(void* lpObj);

int Logoff();

Remarks

Logoff from the OFTP 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.)

Logon Method (OFTPClient Class)

Logon to the OFTP RemoteHost using the current client credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Logon();

Unicode (Windows)
INT Logon();

int ipworksedi_oftpclient_logon(void* lpObj);

int Logon();

Remarks

Logon to the OFTP server using the current ClientSSIDCode, ClientSFIDCode, and ClientPassword. The component will also check the corresponding server credentials, ServerSSIDCode, ServerSFIDCode, and ServerPassword.

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

ReceiveFiles Method (OFTPClient Class)

Receive any files queued to be sent from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReceiveFiles();

Unicode (Windows)
INT ReceiveFiles();

int ipworksedi_oftpclient_receivefiles(void* lpObj);

int ReceiveFiles();

Remarks

This method connects to the server, and receives any files the server has in its outgoing queue to this particular partner. The files are downloaded to the directory specified by the DownloadDirectory property.

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

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksedi_oftpclient_reset(void* lpObj);

int Reset();

Remarks

Reset resets the state of the class. All properties will be set 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.)

SendEndResponse Method (OFTPClient Class)

Sends an EERP/NERP asynchronously.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendEndResponse(const char* lpszVirtualFileName, const char* lpszVirtualFileDate, const char* lpszDestination, const char* lpszOriginator, const char* lpszCreator, int iReasonCode, const char* lpszReasonText, const char* lpszFileHash, const char* lpszSignature);

Unicode (Windows)
INT SendEndResponse(LPCWSTR lpszVirtualFileName, LPCWSTR lpszVirtualFileDate, LPCWSTR lpszDestination, LPCWSTR lpszOriginator, LPCWSTR lpszCreator, INT iReasonCode, LPCWSTR lpszReasonText, LPCWSTR lpszFileHash, LPCWSTR lpszSignature);

int ipworksedi_oftpclient_sendendresponse(void* lpObj, const char* lpszVirtualFileName, const char* lpszVirtualFileDate, const char* lpszDestination, const char* lpszOriginator, const char* lpszCreator, int iReasonCode, const char* lpszReasonText, const char* lpszFileHash, const char* lpszSignature);

int SendEndResponse(const QString& qsVirtualFileName, const QString& qsVirtualFileDate, const QString& qsDestination, const QString& qsOriginator, const QString& qsCreator, int iReasonCode, const QString& qsReasonText, const QString& qsFileHash, const QString& qsSignature);

Remarks

This method sends an EERP/NERP. By default the class will automatically respond with an EERP/NERP when receiving a file. To respond asynchronously instead this method may be used.

To respond asynchronously first set the SendEndResponse parameter of the EndTransfer event to False. This instructs the class to not send a response automatically. Within the EndTransfer event you must also save the values that are required parameters for this method. This includes FileHash, VirtualFileDate, and VirtualFileName. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

Destination should be set to the SFID of the remote host.

Originator should be set to the SFID of the local system. In the case that the class is being used as part of a gateway process to forward traffic to another OFTP host this may be set to the SFID of that host instead.

Creator should be set to the SFID of the local system.

Signature is only applicable if the application is acting as a routing application. In all other cases this should be set to empty string. In the case where the application is acting as a routing application the end response is being forwarded to another entity for processing. The Signature should be set to the value received in the EndResponse event (if populated).

ReasonCode and ReasonText are used to specify error information. If ReasonCode is set to 0 the class will send an EERP. If ReasonCode is set to any non-zero value the class will send a NERP. Common values are:

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

SendFile Method (OFTPClient Class)

Send the specified file to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendFile(const char* lpszLocalFile, const char* lpszVirtualFileName);

Unicode (Windows)
INT SendFile(LPCWSTR lpszLocalFile, LPCWSTR lpszVirtualFileName);

int ipworksedi_oftpclient_sendfile(void* lpObj, const char* lpszLocalFile, const char* lpszVirtualFileName);

int SendFile(const QString& qsLocalFile, const QString& qsVirtualFileName);

Remarks

This method connects to the server, and uploads the specified file to the server. The LocalFile parameter contains the path and name of the file to send to the server. The VirtualFileName parameter contains the virtual file name of the file being sent. If this parameter is left as an empty string, the component will use the filename contained in the LocalFile parameter by default.

Note: When SetUploadStream has been called with a valid input stream, the data will be uploaded from there instead of the LocalFile.

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

ValidateCert Method (OFTPClient Class)

Validates the certificate with private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool ValidateCert();

Unicode (Windows)
INT ValidateCert();

bool ipworksedi_oftpclient_validatecert(void* lpObj);

bool ValidateCert();

Remarks

This method optionally validates the certificate specified by Certificate. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call ImportTrustedCerts to load the trusted certification information.

When this method is called the class:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

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.

ValidateRecipientCert Method (OFTPClient Class)

Validates the recipient certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool ValidateRecipientCert();

Unicode (Windows)
INT ValidateRecipientCert();

bool ipworksedi_oftpclient_validaterecipientcert(void* lpObj);

bool ValidateRecipientCert();

Remarks

This method optionally validates the certificate specified by RecipientCert. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call ImportTrustedCerts to load the trusted certification information.

When this method is called the class:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

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.

AcceptFile Event (OFTPClient Class)

Fired when the client receives a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAcceptFile(OFTPClientAcceptFileEventParams *e);

typedef struct {
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  int Accept;
  char *FileName;
  int Overwrite;
  int ErrorCode;
  char *ErrorDescription;
  int reserved;
} OFTPClientAcceptFileEventParams;


Unicode (Windows)
virtual INT FireAcceptFile(OFTPClientAcceptFileEventParams *e);

typedef struct {
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  BOOL Accept;
  LPWSTR FileName;
  BOOL Overwrite;
  INT ErrorCode;
  LPWSTR ErrorDescription;
  INT reserved;
} OFTPClientAcceptFileEventParams;

#define EID_OFTPCLIENT_ACCEPTFILE 1

virtual INT IPWORKSEDI_CALL FireAcceptFile(LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator, BOOL &bAccept, LPSTR &lpszFileName, BOOL &bOverwrite, INT &iErrorCode, LPSTR &lpszErrorDescription);

class OFTPClientAcceptFileEventParams {
public:
  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

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

  const QString &FileName();
  void SetFileName(const QString &qsFileName);

  bool Overwrite();
  void SetOverwrite(bool bOverwrite);

  int ErrorCode();
  void SetErrorCode(int iErrorCode);

  const QString &ErrorDescription();
  void SetErrorDescription(const QString &qsErrorDescription);

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

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

// Or, subclass OFTPClient and override this emitter function.
virtual int FireAcceptFile(OFTPClientAcceptFileEventParams *e) {...}

Remarks

This event controls the behavior when the client receives a file.

VirtualFileName holds the name of the file being received.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination identifies the receiver (SFID) code in the send file request. If the file was intended for this server this will match the value in ServerSFIDCode

Originator identifies the sender (SFID) code in the send file request.

Accept is true by default, and must be set to False in order to reject the file.

Filename will be populated with the full path and filename that will be written. It may be changed within this event to specify a new location. The Filename is determined by combining the path specified in DownloadDirectory and the name received from the client.

Overwrite is false by default, but may be set to true to overwrite existing files on disk.

ErrorCode controls the error returned to the client when Accept is set to False. If this is not set the class will use a value of 99 to indicate a general error.

ErrorDescription may also be set to include an error message. If this is not set the class will automatically include an error message based on the ErrorCode specified. Common error codes and their corresponding error messages are listed below.

CertificateReceived Event (OFTPClient Class)

Fired when a certificate is received from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCertificateReceived(OFTPClientCertificateReceivedEventParams *e);

typedef struct {
  const char *CertificateFileName;
  int CertificateExchangeType;
  int reserved;
} OFTPClientCertificateReceivedEventParams;


Unicode (Windows)
virtual INT FireCertificateReceived(OFTPClientCertificateReceivedEventParams *e);

typedef struct {
  LPCWSTR CertificateFileName;
  INT CertificateExchangeType;
  INT reserved;
} OFTPClientCertificateReceivedEventParams;

#define EID_OFTPCLIENT_CERTIFICATERECEIVED 2

virtual INT IPWORKSEDI_CALL FireCertificateReceived(LPSTR &lpszCertificateFileName, INT &iCertificateExchangeType);

class OFTPClientCertificateReceivedEventParams {
public:
  const QString &CertificateFileName();

  int CertificateExchangeType();

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

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

// Or, subclass OFTPClient and override this emitter function.
virtual int FireCertificateReceived(OFTPClientCertificateReceivedEventParams *e) {...}

Remarks

This event provides information about the certificate file that was sent by the remote host.

When the remote host sends a certificate using the Certificate Exchange feature of OFTP 2.0, this event provides information about it. The certificate file will be written to the DownloadDirectory. After the file is written to DownloadDirectory this event will fire.

The CertificateFilemame parameter holds the filename of the received certificate.

The CertificateExchangeType parameter identifies the type of request associated with the certificate. Possible values are:

EndResponse Event (OFTPClient Class)

Fired every time an end response is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndResponse(OFTPClientEndResponseEventParams *e);

typedef struct {
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  const char *Creator;
  int ReasonCode;
  const char *ReasonText;
  char *FileHash;
  const char *Signature;
  int Direction;
  int reserved;
} OFTPClientEndResponseEventParams;


Unicode (Windows)
virtual INT FireEndResponse(OFTPClientEndResponseEventParams *e);

typedef struct {
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  LPCWSTR Creator;
  INT ReasonCode;
  LPCWSTR ReasonText;
  LPWSTR FileHash;
  LPCWSTR Signature;
  INT Direction;
  INT reserved;
} OFTPClientEndResponseEventParams;

#define EID_OFTPCLIENT_ENDRESPONSE 3

virtual INT IPWORKSEDI_CALL FireEndResponse(LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator, LPSTR &lpszCreator, INT &iReasonCode, LPSTR &lpszReasonText, LPSTR &lpszFileHash, LPSTR &lpszSignature, INT &iDirection);

class OFTPClientEndResponseEventParams {
public:
  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

  const QString &Creator();

  int ReasonCode();

  const QString &ReasonText();

  const QString &FileHash();
  void SetFileHash(const QString &qsFileHash);

  const QString &Signature();

  int Direction();

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

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

// Or, subclass OFTPClient and override this emitter function.
virtual int FireEndResponse(OFTPClientEndResponseEventParams *e) {...}

Remarks

This event contains information received from an either an End-To-End Response or a Negative End Response received from the server.

An End-To-End Response will not contain values for the ReasonCode, ReasonText, or Creator parameters.

VirtualFileName specifies the name of the file.

VirtualFileDate holds the VirtualFileDate value in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination is the SFID of the destination system (this class).

Originator identifies the system that originated the end response. This is typically the same as Creator and holds the remote system's SFID.

Creator is the SFID of the remote system.

Direction specifies whether the end response is being received or sent. Possible values are:

FileHash is populated if the OFTP Version is 2.0 and a signed receipt was originally requested. FileHash may also be specified with the expected value in the case where an asynchronous EndResponse is received. The expected value may be obtained from the EndTransfer event when initially sending the file.

Signature is only applicable when the OFTP version is 2.0 and the application is acting as a routing application where the end response will be forwarded on to another entity. In this case Signature will be populated if the end response is signed. This should be stored and supplied when forwarding the response with the SendEndResponse method.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

EndTransfer Event (OFTPClient Class)

Fired when a file finishes transferring.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  const char *LocalFile;
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  int ReasonCode;
  const char *ReasonText;
  int64 FileSize;
  const char *FileHash;
  int SendEndResponse;
  int reserved;
} OFTPClientEndTransferEventParams;


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

typedef struct {
  INT Direction;
  LPCWSTR LocalFile;
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  INT ReasonCode;
  LPCWSTR ReasonText;
  LONG64 FileSize;
  LPCWSTR FileHash;
  BOOL SendEndResponse;
  INT reserved;
} OFTPClientEndTransferEventParams;

#define EID_OFTPCLIENT_ENDTRANSFER 4

virtual INT IPWORKSEDI_CALL FireEndTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator, INT &iReasonCode, LPSTR &lpszReasonText, LONG64 &lFileSize, LPSTR &lpszFileHash, BOOL &bSendEndResponse);

class OFTPClientEndTransferEventParams {
public:
  int Direction();

  const QString &LocalFile();

  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

  int ReasonCode();

  const QString &ReasonText();

  qint64 FileSize();

  const QString &FileHash();

  bool SendEndResponse();
  void SetSendEndResponse(bool bSendEndResponse);

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

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

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

Remarks

The EndTransfer event is fired when a file is sent or received by the class.

The FileSize parameter gives the size of the file that was sent or received.

The Direction parameter shows whether the client or the server is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

SendEndResponse indicates whether the EERP/NERP for this request should be sent synchronously or asynchronously. When this parameter is True (default) the class will automatically respond with an EERP/NERP synchronously. To respond asynchronously set this parameter to False. You may then use the SendEndResponse method to send the response at a later time. See SendEndResponse for more details. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

FileHash holds the hash of the file being transmitted. This is only applicable when the OFTP version is 2.0 and the sender requested a signed receipt. When receiving files this value should be saved if you wish to respond asynchronously using SendEndResponse. See SendEndResponse for more details.

LocalFile holds the full path to the file that will be written.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

Error Event (OFTPClient Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_OFTPCLIENT_ERROR 5

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

class OFTPClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

Log Event (OFTPClient Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_OFTPCLIENT_LOG 6

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

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

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

Remarks

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

LogLevel indicates the level of message. Possible values are:

Message is the log entry.

LogType identifies the type of log entry. Possible values are:

• "Info"
• "OFTP"

PITrail Event (OFTPClient Class)

Fired when any protocol level communication occurs.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  const char *Data;
  int lenData;
  int CommandId;
  const char *CommandDescription;
  int reserved;
} OFTPClientPITrailEventParams;


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

typedef struct {
  INT Direction;
  LPCSTR Data;
  INT lenData;
  INT CommandId;
  LPCWSTR CommandDescription;
  INT reserved;
} OFTPClientPITrailEventParams;

#define EID_OFTPCLIENT_PITRAIL 7

virtual INT IPWORKSEDI_CALL FirePITrail(INT &iDirection, LPSTR &lpData, INT &lenData, INT &iCommandId, LPSTR &lpszCommandDescription);

class OFTPClientPITrailEventParams {
public:
  int Direction();

  const QByteArray &Data();

  int CommandId();

  const QString &CommandDescription();

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

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

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

Remarks

This event provides information about the protocol level communication between the client and server.

The Direction parameter specifies who sent the command.

The CommandId and CommandDescription parameters specify which command was sent. The table below shows possible values.

The Data parameter contains the raw OFTP packet.

SSLServerAuthentication Event (OFTPClient Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_OFTPCLIENT_SSLSERVERAUTHENTICATION 8

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

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

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

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

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

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

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

Remarks

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

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

SSLStatus Event (OFTPClient Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_OFTPCLIENT_SSLSTATUS 9

virtual INT IPWORKSEDI_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartTransfer Event (OFTPClient Class)

Fired when a document starts transferring.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  char *LocalFile;
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  int reserved;
} OFTPClientStartTransferEventParams;


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

typedef struct {
  INT Direction;
  LPWSTR LocalFile;
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  INT reserved;
} OFTPClientStartTransferEventParams;

#define EID_OFTPCLIENT_STARTTRANSFER 10

virtual INT IPWORKSEDI_CALL FireStartTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator);

class OFTPClientStartTransferEventParams {
public:
  int Direction();

  const QString &LocalFile();
  void SetLocalFile(const QString &qsLocalFile);

  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

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

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

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

Remarks

This event fires when a file transfer begins.

Direction specifies if the client or server sent the file.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

Transfer Event (OFTPClient Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  const char *LocalFile;
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  int64 BytesTransferred;
  const char *Text;
  int lenText;
  int reserved;
} OFTPClientTransferEventParams;


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

typedef struct {
  INT Direction;
  LPCWSTR LocalFile;
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  LONG64 BytesTransferred;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} OFTPClientTransferEventParams;

#define EID_OFTPCLIENT_TRANSFER 11

virtual INT IPWORKSEDI_CALL FireTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator, LONG64 &lBytesTransferred, LPSTR &lpText, INT &lenText);

class OFTPClientTransferEventParams {
public:
  int Direction();

  const QString &LocalFile();

  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

  qint64 BytesTransferred();

  const QByteArray &Text();

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

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

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

Remarks

The Text parameter contains the portion of the document text being retrieved. It is empty if data is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text.

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

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksEDICertificate (declared in ipworksedi.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)

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksEDIFirewall (declared in ipworksedi.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()

IPWorksEDIList Type

Syntax

IPWorksEDIList<T> (declared in ipworksedi.h)

Remarks

IPWorksEDIList 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 OFTPClient class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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

Config Settings (OFTPClient Class)

OFTPClient Config Settings

Base Config Settings

Trappable Errors (OFTPClient Class)

Error Handling (C++)

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

OFTPClient Errors

TCPClient Errors

TCP/IP Errors