IPWorks EDI 2022 C++ Edition
Version 22.0 [Build 8369]

AS2ProfileMgr Class

Properties   Methods   Events   Config Settings   Errors  

The AS2ProfileMgr class is used to manage self and trading partner profiles used for AS2 communication.

Syntax

AS2ProfileMgr

Remarks

AS2 communication require management of several configuration settings such as encryption certificate, signing certificate and TLS/SSL certificates. Both for your self and your trading partners.

The AS2ProfileMgr class allows you to manage such settings using simple XML files, furthermore these configuration files can be directly fed to the AS2Sender and AS2Receiver Class as a convenient way to set communication parameters.

To use the AS2ProfileMgr you should first set DataDir to configure the directory that it will use to store the profiles. You can then set the properties to be retained and save them by invoking SaveProfile, alternatively you could retrieve previously saved settings using LoadProfile.

When a new trading partner profile is saved a sub-directory named after the trading partner is created within DataDir and the file partner.cfg is saved in it. If CreateDirStruct is set to true, the following sub-directories are created within the partner directory. These can be helpful in managing other data for the trading partner.

DirDeletedDeleted files.
DirIncomingReceived files.
DirLogsLog files.
DirOutgoingFiles to be sent.
DirPendingFiles pending async MDN.
DirPendingInfoFiles having data to verify async MSN.
DirSentSent files.

Property List


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

AsyncMDNURLThe URL for posting Async MDNs.
CreateDirStructOption to create file management directories.
DataDirThe directory that the AS2ProfileMgr uses to store self and trading partner profiles.
DirDeletedThe directory used to store deleted files.
DirIncomingThe directory used to store incoming files.
DirLogsThe directory used to store log files.
DirOutgoingThe directory used to store outgoing files.
DirPendingThe directory used to store files waiting for Async MDN.
DirPendingInfoThe directory used to store files containing data to verify Async MDN.
DirSentThe directory used to store sent files.
EmailYour email address.
EncryptionCertEncodedThis is the certificate (PEM/base64 encoded).
EncryptionCertStoreThis is the name of the certificate store for the client certificate.
EncryptionCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
EncryptionCertStoreTypeThis is the type of certificate store for this certificate.
EncryptionCertSubjectThis is the subject of the certificate used for client authentication.
OptionCompressPreference to compress outgoing data.
OptionEncryptPreference to encrypt outgoing data.
OptionSignPreference to sign outgoing data.
OrganizationThe name of your, or your trading partner's organization.
PartnerCountThe number of partners found in DataDir .
RequestMDNPreference to receive MDNs from trading partner.
RequestMDNSignedPreference to request for signed MDNs.
RequestMDNSynchronousPreference to request for synchronous MDNs.
RequireEncryptPreference to receive encrypted messages.
RequireSignPreference to receive signed messages.
SigningCertEncodedThis is the certificate (PEM/base64 encoded).
SigningCertStoreThis is the name of the certificate store for the client certificate.
SigningCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SigningCertStoreTypeThis is the type of certificate store for this certificate.
SigningCertSubjectThis is the subject of the certificate used for client authentication.
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
URLThe URL for posting EDI data.

Method List


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

ConfigSets or retrieves a configuration setting.
DeleteProfileDeletes the configuration of the specified partner.
GetPropertyGets the property propName .
GetTPInfoGets the profile of the specified partner as a XML TPInfo.
ListPartnersLists trading partners known to the AS2ProfileMgr .
ListPropertiesLists the properties read from self or partner profile.
LoadProfileLoads the profile of the trading partner identified by partnerOrganization .
ResetResets the state of the control.
SaveProfileSaves the profile of the trading partner identified by partnerOrganization .
SetPropertySets the property propName to propValue .

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.

ErrorInformation about errors during data delivery.
PartnerFired when ListPartners is invoked.
PartnerDirectoryFired before accessing partner.cfg of a trading partner.
PropertyFired when ListProperties is invoked.

Config Settings


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

BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

AsyncMDNURL Property (AS2ProfileMgr Class)

The URL for posting Async MDNs.

Syntax

ANSI (Cross Platform)
char* GetAsyncMDNURL();
int SetAsyncMDNURL(const char* lpszAsyncMDNURL); Unicode (Windows) LPWSTR GetAsyncMDNURL();
INT SetAsyncMDNURL(LPCWSTR lpszAsyncMDNURL);
char* ipworksedi_as2profilemgr_getasyncmdnurl(void* lpObj);
int ipworksedi_as2profilemgr_setasyncmdnurl(void* lpObj, const char* lpszAsyncMDNURL);
QString GetAsyncMDNURL();
int SetAsyncMDNURL(QString qsAsyncMDNURL);

Default Value

""

Remarks

This is the URL to which your trading partners would post Async MDNs, if you choose to get asynchronous notifications. The choice of receiving asynchronous notifications can be made on a per partner basis and is reflected in RequestMDNSynchronous.

Data Type

String

CreateDirStruct Property (AS2ProfileMgr Class)

Option to create file management directories.

Syntax

ANSI (Cross Platform)
int GetCreateDirStruct();
int SetCreateDirStruct(int bCreateDirStruct); Unicode (Windows) BOOL GetCreateDirStruct();
INT SetCreateDirStruct(BOOL bCreateDirStruct);
int ipworksedi_as2profilemgr_getcreatedirstruct(void* lpObj);
int ipworksedi_as2profilemgr_setcreatedirstruct(void* lpObj, int bCreateDirStruct);
bool GetCreateDirStruct();
int SetCreateDirStruct(bool bCreateDirStruct);

Default Value

TRUE

Remarks

Set CreateDirStruct to false if you would like AS2ProfileMgr not to create file management directories. These are created for a trading partner when SaveProfile is invoked.

Data Type

Boolean

DataDir Property (AS2ProfileMgr Class)

The directory that the AS2ProfileMgr uses to store self and trading partner profiles.

Syntax

ANSI (Cross Platform)
char* GetDataDir();
int SetDataDir(const char* lpszDataDir); Unicode (Windows) LPWSTR GetDataDir();
INT SetDataDir(LPCWSTR lpszDataDir);
char* ipworksedi_as2profilemgr_getdatadir(void* lpObj);
int ipworksedi_as2profilemgr_setdatadir(void* lpObj, const char* lpszDataDir);
QString GetDataDir();
int SetDataDir(QString qsDataDir);

Default Value

""

Remarks

AS2ProfileMgr uses DataDir to store self and trading partner configuration. The self profile is stored in the XML file me.cfg and the trading partner profiles are stored in the XML file partner.cfg. The partner.cfg is stored in a separate sub-directory for each trading partner. The sub-directory name is derived from the parameter PartnerOrganization of SaveProfile.

Data Type

String

DirDeleted Property (AS2ProfileMgr Class)

The directory used to store deleted files.

Syntax

ANSI (Cross Platform)
char* GetDirDeleted();

Unicode (Windows)
LPWSTR GetDirDeleted();
char* ipworksedi_as2profilemgr_getdirdeleted(void* lpObj);
QString GetDirDeleted();

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing deleted files would have been created. The path to this directory can be read from DirDeleted after invoking LoadProfile.

This property is read-only.

Data Type

String

DirIncoming Property (AS2ProfileMgr Class)

The directory used to store incoming files.

Syntax

ANSI (Cross Platform)
char* GetDirIncoming();

Unicode (Windows)
LPWSTR GetDirIncoming();
char* ipworksedi_as2profilemgr_getdirincoming(void* lpObj);
QString GetDirIncoming();

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing incoming files would have been created. The path to this directory can be read from DirIncoming after invoking LoadProfile.

This property is read-only.

Data Type

String

DirLogs Property (AS2ProfileMgr Class)

The directory used to store log files.

Syntax

ANSI (Cross Platform)
char* GetDirLogs();

Unicode (Windows)
LPWSTR GetDirLogs();
char* ipworksedi_as2profilemgr_getdirlogs(void* lpObj);
QString GetDirLogs();

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing log files would have been created. The path to this directory can be read from DirLogs after invoking LoadProfile.

This property is read-only.

Data Type

String

DirOutgoing Property (AS2ProfileMgr Class)

The directory used to store outgoing files.

Syntax

ANSI (Cross Platform)
char* GetDirOutgoing();

Unicode (Windows)
LPWSTR GetDirOutgoing();
char* ipworksedi_as2profilemgr_getdiroutgoing(void* lpObj);
QString GetDirOutgoing();

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing outgoing files would have been created. The path to this directory can be read from DirOutgoing after invoking LoadProfile.

This property is read-only.

Data Type

String

DirPending Property (AS2ProfileMgr Class)

The directory used to store files waiting for Async MDN.

Syntax

ANSI (Cross Platform)
char* GetDirPending();

Unicode (Windows)
LPWSTR GetDirPending();
char* ipworksedi_as2profilemgr_getdirpending(void* lpObj);
QString GetDirPending();

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing files waiting for Async MDN would have been created. The path to this directory can be read from DirPending after invoking LoadProfile.

This property is read-only.

Data Type

String

DirPendingInfo Property (AS2ProfileMgr Class)

The directory used to store files containing data to verify Async MDN.

Syntax

ANSI (Cross Platform)
char* GetDirPendingInfo();

Unicode (Windows)
LPWSTR GetDirPendingInfo();
char* ipworksedi_as2profilemgr_getdirpendinginfo(void* lpObj);
QString GetDirPendingInfo();

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing files containing data for Async MDN verification would have been created. The path to this directory can be read from DirPendingInfo after invoking LoadProfile.

This property is read-only.

Data Type

String

DirSent Property (AS2ProfileMgr Class)

The directory used to store sent files.

Syntax

ANSI (Cross Platform)
char* GetDirSent();

Unicode (Windows)
LPWSTR GetDirSent();
char* ipworksedi_as2profilemgr_getdirsent(void* lpObj);
QString GetDirSent();

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing sent files would have been created. The path to this directory can be read from DirSent after invoking LoadProfile.

This property is read-only.

Data Type

String

Email Property (AS2ProfileMgr Class)

Your email address.

Syntax

ANSI (Cross Platform)
char* GetEmail();
int SetEmail(const char* lpszEmail); Unicode (Windows) LPWSTR GetEmail();
INT SetEmail(LPCWSTR lpszEmail);
char* ipworksedi_as2profilemgr_getemail(void* lpObj);
int ipworksedi_as2profilemgr_setemail(void* lpObj, const char* lpszEmail);
QString GetEmail();
int SetEmail(QString qsEmail);

Default Value

""

Remarks

Email is used to store your email address. The email address is used to request a MDN. It is simply used as a token to request a MDN, it does not imply that the MDN would be sent to this address. Please refer to the property MDNTo in AS2Sender for details.

After invoking LoadProfile, the Email will contain your currently configured email address, alternatively Email may be set and saved by invoking SaveProfile.

Data Type

String

EncryptionCertEncoded Property (AS2ProfileMgr Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetEncryptionCertEncoded(char* &lpEncryptionCertEncoded, int &lenEncryptionCertEncoded);
int SetEncryptionCertEncoded(const char* lpEncryptionCertEncoded, int lenEncryptionCertEncoded); Unicode (Windows) INT GetEncryptionCertEncoded(LPSTR &lpEncryptionCertEncoded, INT &lenEncryptionCertEncoded);
INT SetEncryptionCertEncoded(LPCSTR lpEncryptionCertEncoded, INT lenEncryptionCertEncoded);
int ipworksedi_as2profilemgr_getencryptioncertencoded(void* lpObj, char** lpEncryptionCertEncoded, int* lenEncryptionCertEncoded);
int ipworksedi_as2profilemgr_setencryptioncertencoded(void* lpObj, const char* lpEncryptionCertEncoded, int lenEncryptionCertEncoded);
QByteArray GetEncryptionCertEncoded();
int SetEncryptionCertEncoded(QByteArray qbaEncryptionCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The EncryptionCertStore and EncryptionCertSubject properties also may be used to specify a certificate.

When EncryptionCertEncoded is set, a search is initiated in the current EncryptionCertStore for the private key of the certificate. If the key is found, EncryptionCertSubject is updated to reflect the full subject of the selected certificate; otherwise, EncryptionCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

EncryptionCertStore Property (AS2ProfileMgr Class)

This is the name of the certificate store for the client certificate.

Syntax

ANSI (Cross Platform)
int GetEncryptionCertStore(char* &lpEncryptionCertStore, int &lenEncryptionCertStore);
int SetEncryptionCertStore(const char* lpEncryptionCertStore, int lenEncryptionCertStore); Unicode (Windows) INT GetEncryptionCertStore(LPSTR &lpEncryptionCertStore, INT &lenEncryptionCertStore);
INT SetEncryptionCertStore(LPCSTR lpEncryptionCertStore, INT lenEncryptionCertStore);
int ipworksedi_as2profilemgr_getencryptioncertstore(void* lpObj, char** lpEncryptionCertStore, int* lenEncryptionCertStore);
int ipworksedi_as2profilemgr_setencryptioncertstore(void* lpObj, const char* lpEncryptionCertStore, int lenEncryptionCertStore);
QByteArray GetEncryptionCertStore();
int SetEncryptionCertStore(QByteArray qbaEncryptionCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The EncryptionCertStoreType property denotes the type of the certificate store specified by EncryptionCertStore. If the store is password protected, specify the password in EncryptionCertStorePassword.

EncryptionCertStore is used in conjunction with the EncryptionCertSubject property to specify client certificates. If EncryptionCertStore has a value, and EncryptionCertSubject or EncryptionCertEncoded is set, a search for a certificate is initiated. Please see the EncryptionCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

EncryptionCertStorePassword Property (AS2ProfileMgr Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

ANSI (Cross Platform)
char* GetEncryptionCertStorePassword();
int SetEncryptionCertStorePassword(const char* lpszEncryptionCertStorePassword); Unicode (Windows) LPWSTR GetEncryptionCertStorePassword();
INT SetEncryptionCertStorePassword(LPCWSTR lpszEncryptionCertStorePassword);
char* ipworksedi_as2profilemgr_getencryptioncertstorepassword(void* lpObj);
int ipworksedi_as2profilemgr_setencryptioncertstorepassword(void* lpObj, const char* lpszEncryptionCertStorePassword);
QString GetEncryptionCertStorePassword();
int SetEncryptionCertStorePassword(QString qsEncryptionCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

EncryptionCertStoreType Property (AS2ProfileMgr Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetEncryptionCertStoreType();
int SetEncryptionCertStoreType(int iEncryptionCertStoreType); Unicode (Windows) INT GetEncryptionCertStoreType();
INT SetEncryptionCertStoreType(INT iEncryptionCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_AUTO(99)
int ipworksedi_as2profilemgr_getencryptioncertstoretype(void* lpObj);
int ipworksedi_as2profilemgr_setencryptioncertstoretype(void* lpObj, int iEncryptionCertStoreType);
int GetEncryptionCertStoreType();
int SetEncryptionCertStoreType(int iEncryptionCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the EncryptionCertStore and set EncryptionCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

EncryptionCertSubject Property (AS2ProfileMgr Class)

This is the subject of the certificate used for client authentication.

Syntax

ANSI (Cross Platform)
char* GetEncryptionCertSubject();
int SetEncryptionCertSubject(const char* lpszEncryptionCertSubject); Unicode (Windows) LPWSTR GetEncryptionCertSubject();
INT SetEncryptionCertSubject(LPCWSTR lpszEncryptionCertSubject);
char* ipworksedi_as2profilemgr_getencryptioncertsubject(void* lpObj);
int ipworksedi_as2profilemgr_setencryptioncertsubject(void* lpObj, const char* lpszEncryptionCertSubject);
QString GetEncryptionCertSubject();
int SetEncryptionCertSubject(QString qsEncryptionCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

Data Type

String

OptionCompress Property (AS2ProfileMgr Class)

Preference to compress outgoing data.

Syntax

ANSI (Cross Platform)
int GetOptionCompress();
int SetOptionCompress(int bOptionCompress); Unicode (Windows) BOOL GetOptionCompress();
INT SetOptionCompress(BOOL bOptionCompress);
int ipworksedi_as2profilemgr_getoptioncompress(void* lpObj);
int ipworksedi_as2profilemgr_setoptioncompress(void* lpObj, int bOptionCompress);
bool GetOptionCompress();
int SetOptionCompress(bool bOptionCompress);

Default Value

FALSE

Remarks

OptionCompress is used to store your preference of compressing the data sent to your trading partner.

After invoking LoadProfile, the OptionCompress will contain your compression preference for your trading partner, alternatively OptionCompress may be set and saved by invoking SaveProfile.

Data Type

Boolean

OptionEncrypt Property (AS2ProfileMgr Class)

Preference to encrypt outgoing data.

Syntax

ANSI (Cross Platform)
int GetOptionEncrypt();
int SetOptionEncrypt(int bOptionEncrypt); Unicode (Windows) BOOL GetOptionEncrypt();
INT SetOptionEncrypt(BOOL bOptionEncrypt);
int ipworksedi_as2profilemgr_getoptionencrypt(void* lpObj);
int ipworksedi_as2profilemgr_setoptionencrypt(void* lpObj, int bOptionEncrypt);
bool GetOptionEncrypt();
int SetOptionEncrypt(bool bOptionEncrypt);

Default Value

FALSE

Remarks

OptionEncrypt is used to store your preference of encrypting data sent to your trading partner. If OptionEncrypt is set to true EncryptionCert must be specified.

After invoking LoadProfile, the OptionEncrypt will contain your encryption preference for your trading partner, alternatively OptionEncrypt may be set and saved by invoking SaveProfile.

Data Type

Boolean

OptionSign Property (AS2ProfileMgr Class)

Preference to sign outgoing data.

Syntax

ANSI (Cross Platform)
int GetOptionSign();
int SetOptionSign(int bOptionSign); Unicode (Windows) BOOL GetOptionSign();
INT SetOptionSign(BOOL bOptionSign);
int ipworksedi_as2profilemgr_getoptionsign(void* lpObj);
int ipworksedi_as2profilemgr_setoptionsign(void* lpObj, int bOptionSign);
bool GetOptionSign();
int SetOptionSign(bool bOptionSign);

Default Value

FALSE

Remarks

OptionSign is used to store your preference of signing the data sent to your trading partner.

After invoking LoadProfile, the OptionSign will contain your signing preference for your trading partner, alternatively OptionSign may be set and saved by invoking SaveProfile.

Data Type

Boolean

Organization Property (AS2ProfileMgr Class)

The name of your, or your trading partner's organization.

Syntax

ANSI (Cross Platform)
char* GetOrganization();
int SetOrganization(const char* lpszOrganization); Unicode (Windows) LPWSTR GetOrganization();
INT SetOrganization(LPCWSTR lpszOrganization);
char* ipworksedi_as2profilemgr_getorganization(void* lpObj);
int ipworksedi_as2profilemgr_setorganization(void* lpObj, const char* lpszOrganization);
QString GetOrganization();
int SetOrganization(QString qsOrganization);

Default Value

""

Remarks

Generally, Organization is used to store your, or your trading partner's AS2 identifier. It is used to configure or verify AS2From and AS2To in AS2Sender and AS2Receiver classs.

Invoking LoadProfile reads the AS2 identifier into Organization, alternatively you can save the AS2 identifier by setting Organization and invoking SaveProfile.

Data Type

String

PartnerCount Property (AS2ProfileMgr Class)

The number of partners found in DataDir .

Syntax

ANSI (Cross Platform)
int GetPartnerCount();

Unicode (Windows)
INT GetPartnerCount();
int ipworksedi_as2profilemgr_getpartnercount(void* lpObj);
int GetPartnerCount();

Default Value

0

Remarks

This property returns the number of partners found in DataDir. This proprety is populated after calling ListPartners.

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

Data Type

Integer

RequestMDN Property (AS2ProfileMgr Class)

Preference to receive MDNs from trading partner.

Syntax

ANSI (Cross Platform)
int GetRequestMDN();
int SetRequestMDN(int bRequestMDN); Unicode (Windows) BOOL GetRequestMDN();
INT SetRequestMDN(BOOL bRequestMDN);
int ipworksedi_as2profilemgr_getrequestmdn(void* lpObj);
int ipworksedi_as2profilemgr_setrequestmdn(void* lpObj, int bRequestMDN);
bool GetRequestMDN();
int SetRequestMDN(bool bRequestMDN);

Default Value

FALSE

Remarks

RequireMDN is used to store your preference of receiving MDNs for the messages you send to your trading partner.

After invoking LoadProfile, the RequireMDN will contain your preference of receiving MDNs, alternatively RequireMDN may be set and saved by invoking SaveProfile.

Data Type

Boolean

RequestMDNSigned Property (AS2ProfileMgr Class)

Preference to request for signed MDNs.

Syntax

ANSI (Cross Platform)
int GetRequestMDNSigned();
int SetRequestMDNSigned(int bRequestMDNSigned); Unicode (Windows) BOOL GetRequestMDNSigned();
INT SetRequestMDNSigned(BOOL bRequestMDNSigned);
int ipworksedi_as2profilemgr_getrequestmdnsigned(void* lpObj);
int ipworksedi_as2profilemgr_setrequestmdnsigned(void* lpObj, int bRequestMDNSigned);
bool GetRequestMDNSigned();
int SetRequestMDNSigned(bool bRequestMDNSigned);

Default Value

TRUE

Remarks

MDNRequestSigned is used to store your preference of requesting signed MDNs from your trading partner.

After invoking LoadProfile, the MDNRequestSigned will contain your preference of requesting signed MDNs, alternatively MDNRequestSigned may be set and saved by invoking SaveProfile.

Data Type

Boolean

RequestMDNSynchronous Property (AS2ProfileMgr Class)

Preference to request for synchronous MDNs.

Syntax

ANSI (Cross Platform)
int GetRequestMDNSynchronous();
int SetRequestMDNSynchronous(int bRequestMDNSynchronous); Unicode (Windows) BOOL GetRequestMDNSynchronous();
INT SetRequestMDNSynchronous(BOOL bRequestMDNSynchronous);
int ipworksedi_as2profilemgr_getrequestmdnsynchronous(void* lpObj);
int ipworksedi_as2profilemgr_setrequestmdnsynchronous(void* lpObj, int bRequestMDNSynchronous);
bool GetRequestMDNSynchronous();
int SetRequestMDNSynchronous(bool bRequestMDNSynchronous);

Default Value

TRUE

Remarks

MDNRequestSynchronous is used to store your preference of requesting synchronous MDNs from your trading partner.

After invoking LoadProfile, the MDNRequestSynchronous will contain your preference of requesting synchronous MDNs, alternatively MDNRequestSynchronous may be set and saved by invoking SaveProfile.

Data Type

Boolean

RequireEncrypt Property (AS2ProfileMgr Class)

Preference to receive encrypted messages.

Syntax

ANSI (Cross Platform)
int GetRequireEncrypt();
int SetRequireEncrypt(int bRequireEncrypt); Unicode (Windows) BOOL GetRequireEncrypt();
INT SetRequireEncrypt(BOOL bRequireEncrypt);
int ipworksedi_as2profilemgr_getrequireencrypt(void* lpObj);
int ipworksedi_as2profilemgr_setrequireencrypt(void* lpObj, int bRequireEncrypt);
bool GetRequireEncrypt();
int SetRequireEncrypt(bool bRequireEncrypt);

Default Value

FALSE

Remarks

RequireEncrypt is used to store your preference of receiving encrypted messages from your trading partner.

After invoking LoadProfile, the RequireEncrypt will contain your preference of receiving encrypted messages, alternatively RequireEncrypt may be set and saved by invoking SaveProfile.

Data Type

Boolean

RequireSign Property (AS2ProfileMgr Class)

Preference to receive signed messages.

Syntax

ANSI (Cross Platform)
int GetRequireSign();
int SetRequireSign(int bRequireSign); Unicode (Windows) BOOL GetRequireSign();
INT SetRequireSign(BOOL bRequireSign);
int ipworksedi_as2profilemgr_getrequiresign(void* lpObj);
int ipworksedi_as2profilemgr_setrequiresign(void* lpObj, int bRequireSign);
bool GetRequireSign();
int SetRequireSign(bool bRequireSign);

Default Value

FALSE

Remarks

RequireSign is used to store your preference of receiving signed messages from your trading partner.

After invoking LoadProfile, the RequireSign will contain your preference of receiving signed messages, alternatively RequireSign may be set and saved by invoking SaveProfile.

Data Type

Boolean

SigningCertEncoded Property (AS2ProfileMgr Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSigningCertEncoded(char* &lpSigningCertEncoded, int &lenSigningCertEncoded);
int SetSigningCertEncoded(const char* lpSigningCertEncoded, int lenSigningCertEncoded); Unicode (Windows) INT GetSigningCertEncoded(LPSTR &lpSigningCertEncoded, INT &lenSigningCertEncoded);
INT SetSigningCertEncoded(LPCSTR lpSigningCertEncoded, INT lenSigningCertEncoded);
int ipworksedi_as2profilemgr_getsigningcertencoded(void* lpObj, char** lpSigningCertEncoded, int* lenSigningCertEncoded);
int ipworksedi_as2profilemgr_setsigningcertencoded(void* lpObj, const char* lpSigningCertEncoded, int lenSigningCertEncoded);
QByteArray GetSigningCertEncoded();
int SetSigningCertEncoded(QByteArray qbaSigningCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SigningCertStore and SigningCertSubject properties also may be used to specify a certificate.

When SigningCertEncoded is set, a search is initiated in the current SigningCertStore for the private key of the certificate. If the key is found, SigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SigningCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SigningCertStore Property (AS2ProfileMgr Class)

This is the name of the certificate store for the client certificate.

Syntax

ANSI (Cross Platform)
int GetSigningCertStore(char* &lpSigningCertStore, int &lenSigningCertStore);
int SetSigningCertStore(const char* lpSigningCertStore, int lenSigningCertStore); Unicode (Windows) INT GetSigningCertStore(LPSTR &lpSigningCertStore, INT &lenSigningCertStore);
INT SetSigningCertStore(LPCSTR lpSigningCertStore, INT lenSigningCertStore);
int ipworksedi_as2profilemgr_getsigningcertstore(void* lpObj, char** lpSigningCertStore, int* lenSigningCertStore);
int ipworksedi_as2profilemgr_setsigningcertstore(void* lpObj, const char* lpSigningCertStore, int lenSigningCertStore);
QByteArray GetSigningCertStore();
int SetSigningCertStore(QByteArray qbaSigningCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SigningCertStoreType property denotes the type of the certificate store specified by SigningCertStore. If the store is password protected, specify the password in SigningCertStorePassword.

SigningCertStore is used in conjunction with the SigningCertSubject property to specify client certificates. If SigningCertStore has a value, and SigningCertSubject or SigningCertEncoded is set, a search for a certificate is initiated. Please see the SigningCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SigningCertStorePassword Property (AS2ProfileMgr Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

ANSI (Cross Platform)
char* GetSigningCertStorePassword();
int SetSigningCertStorePassword(const char* lpszSigningCertStorePassword); Unicode (Windows) LPWSTR GetSigningCertStorePassword();
INT SetSigningCertStorePassword(LPCWSTR lpszSigningCertStorePassword);
char* ipworksedi_as2profilemgr_getsigningcertstorepassword(void* lpObj);
int ipworksedi_as2profilemgr_setsigningcertstorepassword(void* lpObj, const char* lpszSigningCertStorePassword);
QString GetSigningCertStorePassword();
int SetSigningCertStorePassword(QString qsSigningCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SigningCertStoreType Property (AS2ProfileMgr Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSigningCertStoreType();
int SetSigningCertStoreType(int iSigningCertStoreType); Unicode (Windows) INT GetSigningCertStoreType();
INT SetSigningCertStoreType(INT iSigningCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_AUTO(99)
int ipworksedi_as2profilemgr_getsigningcertstoretype(void* lpObj);
int ipworksedi_as2profilemgr_setsigningcertstoretype(void* lpObj, int iSigningCertStoreType);
int GetSigningCertStoreType();
int SetSigningCertStoreType(int iSigningCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SigningCertStore and set SigningCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SigningCertSubject Property (AS2ProfileMgr Class)

This is the subject of the certificate used for client authentication.

Syntax

ANSI (Cross Platform)
char* GetSigningCertSubject();
int SetSigningCertSubject(const char* lpszSigningCertSubject); Unicode (Windows) LPWSTR GetSigningCertSubject();
INT SetSigningCertSubject(LPCWSTR lpszSigningCertSubject);
char* ipworksedi_as2profilemgr_getsigningcertsubject(void* lpObj);
int ipworksedi_as2profilemgr_setsigningcertsubject(void* lpObj, const char* lpszSigningCertSubject);
QString GetSigningCertSubject();
int SetSigningCertSubject(QString qsSigningCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLCertEncoded Property (AS2ProfileMgr Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int ipworksedi_as2profilemgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_as2profilemgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AS2ProfileMgr Class)

This is the name of the certificate store for the client certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int ipworksedi_as2profilemgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_as2profilemgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (AS2ProfileMgr Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* ipworksedi_as2profilemgr_getsslcertstorepassword(void* lpObj);
int ipworksedi_as2profilemgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AS2ProfileMgr Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_AUTO(99)
int ipworksedi_as2profilemgr_getsslcertstoretype(void* lpObj);
int ipworksedi_as2profilemgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (AS2ProfileMgr Class)

This is the subject of the certificate used for client authentication.

Syntax

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* ipworksedi_as2profilemgr_getsslcertsubject(void* lpObj);
int ipworksedi_as2profilemgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

Data Type

String

URL Property (AS2ProfileMgr Class)

The URL for posting EDI data.

Syntax

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL); Unicode (Windows) LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);
char* ipworksedi_as2profilemgr_geturl(void* lpObj);
int ipworksedi_as2profilemgr_seturl(void* lpObj, const char* lpszURL);
QString GetURL();
int SetURL(QString qsURL);

Default Value

""

Remarks

URL is the URL provided by your trading partner for posting EDI Data. Please refer to the URL property in AS2Sender for details.

In the case of "self" profile i.e. when the parameter partnerIdentifier is "self" in LoadProfile or SaveProfile, URL refers to the URL that your trading partners use to post data to you.

After invoking LoadProfile, the URL will contain the URL of your trading partner, alternatively URL may be set and saved by invoking SaveProfile.

Data Type

String

Config Method (AS2ProfileMgr Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksedi_as2profilemgr_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.

DeleteProfile Method (AS2ProfileMgr Class)

Deletes the configuration of the specified partner.

Syntax

ANSI (Cross Platform)
int DeleteProfile(const char* lpszpartnerOrganization);

Unicode (Windows)
INT DeleteProfile(LPCWSTR lpszpartnerOrganization);
int ipworksedi_as2profilemgr_deleteprofile(void* lpObj, const char* lpszpartnerOrganization);
int DeleteProfile(const QString& qspartnerOrganization);

Remarks

The profile of the partner identified by partnerIdentifier is deleted. This method also deletes the directory in which the partner profile is stored, consequently deleting file management directories of the partner.

If the partnerOrganization specified is "self", the self profile i.e. me.cfg, is cleared.

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

GetProperty Method (AS2ProfileMgr Class)

Gets the property propName .

Syntax

ANSI (Cross Platform)
char* GetProperty(const char* lpszpropName);

Unicode (Windows)
LPWSTR GetProperty(LPCWSTR lpszpropName);
char* ipworksedi_as2profilemgr_getproperty(void* lpObj, const char* lpszpropName);
QString GetProperty(const QString& qspropName);

Remarks

GetProperty can be used to query any property from "self" or partner profile. It is specially useful in retrieving properties not interpreted by AS2Sender AS2Receiver classs and thus not exposed as AS2ProfileMgr properties.

GetProperty returns null if property propName was not read by LoadProfile.

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.

GetTPInfo Method (AS2ProfileMgr Class)

Gets the profile of the specified partner as a XML TPInfo.

Syntax

ANSI (Cross Platform)
char* GetTPInfo(const char* lpszpartnerOrganization);

Unicode (Windows)
LPWSTR GetTPInfo(LPCWSTR lpszpartnerOrganization);
char* ipworksedi_as2profilemgr_gettpinfo(void* lpObj, const char* lpszpartnerOrganization);
QString GetTPInfo(const QString& qspartnerOrganization);

Remarks

If the parameter partnerOrganization is "self", GetTPInfo returns a XML string representing the "self" profile otherwise it returns a XML string of partner profile. These strings can be directly fed to AS2Sender and AS2Receiver using the method SetTPInfo.

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.

ListPartners Method (AS2ProfileMgr Class)

Lists trading partners known to the AS2ProfileMgr .

Syntax

ANSI (Cross Platform)
int ListPartners();

Unicode (Windows)
INT ListPartners();
int ipworksedi_as2profilemgr_listpartners(void* lpObj);
int ListPartners();

Remarks

Invoking ListPartners causes the event Partner to be fired for each trading partner profile found by the AS2ProfileMgr class.

After this method returns PartnerCount is populated with the number of found partners.

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

ListProperties Method (AS2ProfileMgr Class)

Lists the properties read from self or partner profile.

Syntax

ANSI (Cross Platform)
int ListProperties();

Unicode (Windows)
INT ListProperties();
int ipworksedi_as2profilemgr_listproperties(void* lpObj);
int ListProperties();

Remarks

Invoking ListProperties causes the event Property to be fired for each property read by LoadProfile.

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

LoadProfile Method (AS2ProfileMgr Class)

Loads the profile of the trading partner identified by partnerOrganization .

Syntax

ANSI (Cross Platform)
int LoadProfile(const char* lpszpartnerOrganization);

Unicode (Windows)
INT LoadProfile(LPCWSTR lpszpartnerOrganization);
int ipworksedi_as2profilemgr_loadprofile(void* lpObj, const char* lpszpartnerOrganization);
int LoadProfile(const QString& qspartnerOrganization);

Remarks

If the partnerOrganization is not "self", the properties of AS2ProfileMgr are read from the XML file partner.cfg. The file is expected to be in a sub-directory within DataDir. The name of the sub-directory is derived from partnerOrganization.

Although all properties are read from the partner profile, the following are interpreted by AS2Sender and AS2Receiver classs.

Partner Settings

If the partnerOrganization specified is "self", the properties of AS2ProfileMgr are read from the XML file me.cfg. The file is expected to be in DataDir.

Although all properties are read from the self profile, the following are interpreted by AS2Sender and AS2Receiver classs.

My Settings

Note: "self" cannot be the name of a trading partner organization.

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

Resets the state of the control.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworksedi_as2profilemgr_reset(void* lpObj);
int Reset();

Remarks

Resets all properties. After invoking this method the class may be reused as if it were newly created.

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

SaveProfile Method (AS2ProfileMgr Class)

Saves the profile of the trading partner identified by partnerOrganization .

Syntax

ANSI (Cross Platform)
int SaveProfile(const char* lpszpartnerOrganization);

Unicode (Windows)
INT SaveProfile(LPCWSTR lpszpartnerOrganization);
int ipworksedi_as2profilemgr_saveprofile(void* lpObj, const char* lpszpartnerOrganization);
int SaveProfile(const QString& qspartnerOrganization);

Remarks

If the partnerOrganization is not "self", the properties of AS2ProfileMgr are saved to the XML file partner.cfg placed in a sub-directory within DataDir. The name of the sub-directory is derived from partnerOrganization. In addition to saving the partner profile, SaveProfile also creates the following directories if CreateDirStruct is set to true.

DirDeletedDeleted files.
DirIncomingReceived files.
DirLogsLog files.
DirOutgoingFiles to be sent.
DirPendingFiles pending async MDN.
DirPendingInfoFiles having data to verify async MSN.
DirSentSent files.

Although any number of properties may be saved to the partner profile, the following are interpreted by AS2Sender and AS2Receiver classes.

Partner Settings

If the partnerOrganization specified is "self", the properties of AS2ProfileMgr are saved to the XML file me.cfg placed in DataDir.

Although any number of properties may be saved to the self profile, the following are interpreted by AS2Sender and AS2Receiver classes.

My Settings

Note: "self" cannot be the name of a trading partner organization.

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

SetProperty Method (AS2ProfileMgr Class)

Sets the property propName to propValue .

Syntax

ANSI (Cross Platform)
int SetProperty(const char* lpszpropName, const char* lpszpropValue);

Unicode (Windows)
INT SetProperty(LPCWSTR lpszpropName, LPCWSTR lpszpropValue);
int ipworksedi_as2profilemgr_setproperty(void* lpObj, const char* lpszpropName, const char* lpszpropValue);
int SetProperty(const QString& qspropName, const QString& qspropValue);

Remarks

SetProperty can be used to set any property in self or partner profile. It is specially useful in setting properties not interpreted by AS2Sender AS2Receiverclasss and thus not exposed as AS2ProfileMgr properties.

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

Error Event (AS2ProfileMgr Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(AS2ProfileMgrErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } AS2ProfileMgrErrorEventParams;
Unicode (Windows) virtual INT FireError(AS2ProfileMgrErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } AS2ProfileMgrErrorEventParams;
#define EID_AS2PROFILEMGR_ERROR 1

virtual INT IPWORKSEDI_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class AS2ProfileMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(AS2ProfileMgrErrorEventParams *e);
// Or, subclass AS2ProfileMgr and override this emitter function. virtual int FireError(AS2ProfileMgrErrorEventParams *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.

Partner Event (AS2ProfileMgr Class)

Fired when ListPartners is invoked.

Syntax

ANSI (Cross Platform)
virtual int FirePartner(AS2ProfileMgrPartnerEventParams *e);
typedef struct {
const char *partnerIdentifier;
const char *partnerURL; int reserved; } AS2ProfileMgrPartnerEventParams;
Unicode (Windows) virtual INT FirePartner(AS2ProfileMgrPartnerEventParams *e);
typedef struct {
LPCWSTR partnerIdentifier;
LPCWSTR partnerURL; INT reserved; } AS2ProfileMgrPartnerEventParams;
#define EID_AS2PROFILEMGR_PARTNER 2

virtual INT IPWORKSEDI_CALL FirePartner(LPSTR &lpszpartnerIdentifier, LPSTR &lpszpartnerURL);
class AS2ProfileMgrPartnerEventParams {
public:
  const QString &partnerIdentifier();

  const QString &partnerURL();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Partner(AS2ProfileMgrPartnerEventParams *e);
// Or, subclass AS2ProfileMgr and override this emitter function. virtual int FirePartner(AS2ProfileMgrPartnerEventParams *e) {...}

Remarks

This event is fired when ListPartners is called. It fires for each partner found by the AS2ProfileMgr in DataDir. The parameter partnerIdentifier is same as provided to SaveProfile to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from partnerURL.

PartnerDirectory Event (AS2ProfileMgr Class)

Fired before accessing partner.cfg of a trading partner.

Syntax

ANSI (Cross Platform)
virtual int FirePartnerDirectory(AS2ProfileMgrPartnerDirectoryEventParams *e);
typedef struct {
const char *Name;
char *Directory; int reserved; } AS2ProfileMgrPartnerDirectoryEventParams;
Unicode (Windows) virtual INT FirePartnerDirectory(AS2ProfileMgrPartnerDirectoryEventParams *e);
typedef struct {
LPCWSTR Name;
LPWSTR Directory; INT reserved; } AS2ProfileMgrPartnerDirectoryEventParams;
#define EID_AS2PROFILEMGR_PARTNERDIRECTORY 3

virtual INT IPWORKSEDI_CALL FirePartnerDirectory(LPSTR &lpszName, LPSTR &lpszDirectory);
class AS2ProfileMgrPartnerDirectoryEventParams {
public:
  const QString &Name();

  const QString &Directory();
  void SetDirectory(const QString &qsDirectory);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void PartnerDirectory(AS2ProfileMgrPartnerDirectoryEventParams *e);
// Or, subclass AS2ProfileMgr and override this emitter function. virtual int FirePartnerDirectory(AS2ProfileMgrPartnerDirectoryEventParams *e) {...}

Remarks

This event is fired every time partner.cfg needs to be accessed i.e when LoadProfile or GetTPInfo are invoked with partner name not being "self". The Name provides the partner name and Directory indicates the directory in which partner profile is expected. Setting Directory to a different path will make the component look for partner.cfg in that directory. Note: PartnerDirectory event is not fired when ListPartners is invoked.

Property Event (AS2ProfileMgr Class)

Fired when ListProperties is invoked.

Syntax

ANSI (Cross Platform)
virtual int FireProperty(AS2ProfileMgrPropertyEventParams *e);
typedef struct {
const char *propName;
const char *propValue; int reserved; } AS2ProfileMgrPropertyEventParams;
Unicode (Windows) virtual INT FireProperty(AS2ProfileMgrPropertyEventParams *e);
typedef struct {
LPCWSTR propName;
LPCWSTR propValue; INT reserved; } AS2ProfileMgrPropertyEventParams;
#define EID_AS2PROFILEMGR_PROPERTY 4

virtual INT IPWORKSEDI_CALL FireProperty(LPSTR &lpszpropName, LPSTR &lpszpropValue);
class AS2ProfileMgrPropertyEventParams {
public:
  const QString &propName();

  const QString &propValue();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Property(AS2ProfileMgrPropertyEventParams *e);
// Or, subclass AS2ProfileMgr and override this emitter function. virtual int FireProperty(AS2ProfileMgrPropertyEventParams *e) {...}

Remarks

This event is fired when ListProperties is called. It fires for each property read by LoadProfile. The parameters propName and propValue provide property name and value respectively.

Config Settings (AS2ProfileMgr Class)

The class accepts one or more of the following configuration settings. Configuration 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.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (AS2ProfileMgr 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.

AS2ProfileMgr Errors

601   Cannot access data directory.
602   This operation requires data directory to be set.
603   Cannot save personal profile.
604   Cannot load personal profile.
605   Cannot save partner profile.
606   Cannot load partner profile.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2022 C++ Edition - Version 22.0 [Build 8369]