TSYSLevel2 Class

Properties   Methods   Events   Config Settings   Errors  

The TSYSLevel2 class is a tool used to create Level2 Corporate Purchasing Card addendum aggregates, which can then be passed to the TSYSSETTLE class and settled.

Syntax

TSYSLevel2

Remarks

The type of addendum created by this class depends upon the value of the CardType property. If the CardType is tctVisa or tctMasterCard the addendum created by the GetAddendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). Properties valid for these CardTypes are: IsTaxExempt, LocalSalesTax, and PurchaseOrderNumber. The following example illustrates how to add a Visa/MasterCard Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctVisa TSYSLevel2.IsTaxExempt = False TSYSLevel2.LocalSalesTax = "423" // $4.23 TSYSLevel2.PurchaseOrderNumber = "12345678901234567" TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel2.GetAddendum();

If the CardType is tctAmericanExpress, the addendum created will be Group 21 (ODG21). Only the properties prefixed with "Amex" are applicable in this case. These include: AmexCardholderReference, AmexChargeDescriptor, AmexSalesTax, AmexShippedToZip, and AmexSupplierNumber. The following example shows how to add an American Express Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctAmericanExpress TSYSLevel2.AmexCardholderReference = "INV12345678" TSYSLevel2.AmexChargeDescriptor = "Test transaction" TSYSLevel2.AmexSalesTax = "373" TSYSLevel2.AmexShippedToZip = "90210" TSYSLevel2.AmexSupplierNumber = "SUP244568" TSYSSettle.DetailRecords[1].AddendumAggregate = TSYSLevel2.GetAddendum();

Note that while Level2 addendum data is only applicable to corporate purchasing cards, you may send Level2 data for all Visa, Master Card, and American Express cards if you wish.

Note: If you are attempting to settle American Express transactions which include Level2 commercial card data, and you receive an error indicating that the "Record Type is missing or invalid" for the Detail Record containing that transaction, the problem is that your merchant account is not set up to settle American Express commercial cards.

Property List


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

AmexCardholderReferenceReference number supplied by the card holder.
AmexChargeDescriptorDescription of this transaction.
AmexSalesTaxPortion of the transaction amount which is sales tax.
AmexShippedToZipThe zip code to which the commodity was shipped.
AmexSupplierNumberSupplier Reference Number contained in the American Express Level 2 addendum.
CardTypeThe card type for which a Level2 or Level3 addendum will be created.
IsTaxExemptIndicates whether this purchasing card qualifies for tax-exempt status.
LocalSalesTaxSales tax charged in addition to the original TransactionAmount .
PurchaseOrderNumberOptional customer-specified purchase order number.

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.
GetAddendumReturns a Level2 Purchasing card addendum based on the specified CardType .
ResetClears all properties to their default values.

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.

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.
MaskSensitiveWhether sensitive data is masked in log messages.
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.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AmexCardholderReference Property (TSYSLevel2 Class)

Reference number supplied by the card holder.

Syntax

ANSI (Cross Platform)
char* GetAmexCardholderReference();
int SetAmexCardholderReference(const char* lpszAmexCardholderReference); Unicode (Windows) LPWSTR GetAmexCardholderReference();
INT SetAmexCardholderReference(LPCWSTR lpszAmexCardholderReference);
char* dpaymentssdk_tsyslevel2_getamexcardholderreference(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexcardholderreference(void* lpObj, const char* lpszAmexCardholderReference);
QString GetAmexCardholderReference();
int SetAmexCardholderReference(QString qsAmexCardholderReference);

Default Value

""

Remarks

This property is defined by the card member and entered by the merchant at the point-of-sale. This information will be displayed within the Statement/Reporting process and may include accounting information specific to the client.

The maximum length for this property is 17 characters.

Data Type

String

AmexChargeDescriptor Property (TSYSLevel2 Class)

Description of this transaction.

Syntax

ANSI (Cross Platform)
char* GetAmexChargeDescriptor();
int SetAmexChargeDescriptor(const char* lpszAmexChargeDescriptor); Unicode (Windows) LPWSTR GetAmexChargeDescriptor();
INT SetAmexChargeDescriptor(LPCWSTR lpszAmexChargeDescriptor);
char* dpaymentssdk_tsyslevel2_getamexchargedescriptor(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexchargedescriptor(void* lpObj, const char* lpszAmexChargeDescriptor);
QString GetAmexChargeDescriptor();
int SetAmexChargeDescriptor(QString qsAmexChargeDescriptor);

Default Value

""

Remarks

This property may contain up to 40 characters of free text (Spaces allowed). This is a required property for an American Express addendum.

Data Type

String

AmexSalesTax Property (TSYSLevel2 Class)

Portion of the transaction amount which is sales tax.

Syntax

ANSI (Cross Platform)
char* GetAmexSalesTax();
int SetAmexSalesTax(const char* lpszAmexSalesTax); Unicode (Windows) LPWSTR GetAmexSalesTax();
INT SetAmexSalesTax(LPCWSTR lpszAmexSalesTax);
char* dpaymentssdk_tsyslevel2_getamexsalestax(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexsalestax(void* lpObj, const char* lpszAmexSalesTax);
QString GetAmexSalesTax();
int SetAmexSalesTax(QString qsAmexSalesTax);

Default Value

""

Remarks

The sales tax charged must be included in the TransactionAmount of the original transaction.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The maximum length of this field is 6 digits, thus the maximum AmexSalesTax is "999999", yielding a US dollar amount of $9,999.99. This field may not contain a negative number.

Data Type

String

AmexShippedToZip Property (TSYSLevel2 Class)

The zip code to which the commodity was shipped.

Syntax

ANSI (Cross Platform)
char* GetAmexShippedToZip();
int SetAmexShippedToZip(const char* lpszAmexShippedToZip); Unicode (Windows) LPWSTR GetAmexShippedToZip();
INT SetAmexShippedToZip(LPCWSTR lpszAmexShippedToZip);
char* dpaymentssdk_tsyslevel2_getamexshippedtozip(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexshippedtozip(void* lpObj, const char* lpszAmexShippedToZip);
QString GetAmexShippedToZip();
int SetAmexShippedToZip(QString qsAmexShippedToZip);

Default Value

""

Remarks

If the ship-to zip code is not available, or the customer purchased the item in person (Card-present transaction), this property should be defaulted to the zip code of the merchant where the purchase took place.

The maximum length for this property is 6 characters.

Data Type

String

AmexSupplierNumber Property (TSYSLevel2 Class)

Supplier Reference Number contained in the American Express Level 2 addendum.

Syntax

ANSI (Cross Platform)
char* GetAmexSupplierNumber();
int SetAmexSupplierNumber(const char* lpszAmexSupplierNumber); Unicode (Windows) LPWSTR GetAmexSupplierNumber();
INT SetAmexSupplierNumber(LPCWSTR lpszAmexSupplierNumber);
char* dpaymentssdk_tsyslevel2_getamexsuppliernumber(void* lpObj);
int dpaymentssdk_tsyslevel2_setamexsuppliernumber(void* lpObj, const char* lpszAmexSupplierNumber);
QString GetAmexSupplierNumber();
int SetAmexSupplierNumber(QString qsAmexSupplierNumber);

Default Value

""

Remarks

This property contains a reference number that is used by American Express to obtain supporting information on a charge from a Merchant. Supporting documentation should be readily available in case of inquiry. The number can be any combination of characters and numerals defined by the Merchant or Authorized Processor. However, it must be an index to the Merchant's record, so that charge information can be readily retrieved and promptly submitted within 10 calendar days (or within the period stipulated in the contractual agreement). This number appears on the card member descriptive billing and Merchant inquiry reports.

The maximum length for this property is 9 characters.

Data Type

String

CardType Property (TSYSLevel2 Class)

The card type for which a Level2 or Level3 addendum will be created.

Syntax

ANSI (Cross Platform)
int GetCardType();
int SetCardType(int iCardType); Unicode (Windows) INT GetCardType();
INT SetCardType(INT iCardType);

Possible Values

TCT_VISA(0), 
TCT_MASTER_CARD(1),
TCT_AMERICAN_EXPRESS(2)
int dpaymentssdk_tsyslevel2_getcardtype(void* lpObj);
int dpaymentssdk_tsyslevel2_setcardtype(void* lpObj, int iCardType);
int GetCardType();
int SetCardType(int iCardType);

Default Value

0

Remarks

The value of this property MUST correspond to the card number that is to be settled in the detail record (to which this addendum is associated). Valid values for this property include:

tctVisa (0) Visa card.
tctMasterCard (1) MasterCard card.
tctAmericanExpress (2) American Express card. (NOTE: American Express is not available for Level3).

Data Type

Integer

IsTaxExempt Property (TSYSLevel2 Class)

Indicates whether this purchasing card qualifies for tax-exempt status.

Syntax

ANSI (Cross Platform)
int GetIsTaxExempt();
int SetIsTaxExempt(int bIsTaxExempt); Unicode (Windows) BOOL GetIsTaxExempt();
INT SetIsTaxExempt(BOOL bIsTaxExempt);
int dpaymentssdk_tsyslevel2_getistaxexempt(void* lpObj);
int dpaymentssdk_tsyslevel2_setistaxexempt(void* lpObj, int bIsTaxExempt);
bool GetIsTaxExempt();
int SetIsTaxExempt(bool bIsTaxExempt);

Default Value

FALSE

Remarks

This property cannot be True if there is a LocalTax amount set.

Data Type

Boolean

LocalSalesTax Property (TSYSLevel2 Class)

Sales tax charged in addition to the original TransactionAmount .

Syntax

ANSI (Cross Platform)
char* GetLocalSalesTax();
int SetLocalSalesTax(const char* lpszLocalSalesTax); Unicode (Windows) LPWSTR GetLocalSalesTax();
INT SetLocalSalesTax(LPCWSTR lpszLocalSalesTax);
char* dpaymentssdk_tsyslevel2_getlocalsalestax(void* lpObj);
int dpaymentssdk_tsyslevel2_setlocalsalestax(void* lpObj, const char* lpszLocalSalesTax);
QString GetLocalSalesTax();
int SetLocalSalesTax(QString qsLocalSalesTax);

Default Value

""

Remarks

Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The maximum length of this property is 12 digits.

Data Type

String

PurchaseOrderNumber Property (TSYSLevel2 Class)

Optional customer-specified purchase order number.

Syntax

ANSI (Cross Platform)
char* GetPurchaseOrderNumber();
int SetPurchaseOrderNumber(const char* lpszPurchaseOrderNumber); Unicode (Windows) LPWSTR GetPurchaseOrderNumber();
INT SetPurchaseOrderNumber(LPCWSTR lpszPurchaseOrderNumber);
char* dpaymentssdk_tsyslevel2_getpurchaseordernumber(void* lpObj);
int dpaymentssdk_tsyslevel2_setpurchaseordernumber(void* lpObj, const char* lpszPurchaseOrderNumber);
QString GetPurchaseOrderNumber();
int SetPurchaseOrderNumber(QString qsPurchaseOrderNumber);

Default Value

""

Remarks

This property contains a 16, 17, or 25-character Purchase Order Number or Customer Reference Identifier supplied by the Visa or MasterCard Purchasing Card cardholder.

This property is used for both Visa and MasterCard Corporate Purchasing Cards.

Data Type

String

Config Method (TSYSLevel2 Class)

Sets or retrieves a configuration setting.

Syntax

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

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

GetAddendum Method (TSYSLevel2 Class)

Returns a Level2 Purchasing card addendum based on the specified CardType .

Syntax

ANSI (Cross Platform)
char* GetAddendum();

Unicode (Windows)
LPWSTR GetAddendum();
char* dpaymentssdk_tsyslevel2_getaddendum(void* lpObj);
QString GetAddendum();

Remarks

The type of addendum created by this class depends upon the value of the CardType property. If the CardType is tctVisa or tctMasterCard the addendum created by the GetAddendum method will be sent as part of ODG41 group (Tags: "OAI", "OA", and "PON"). Properties valid for these CardTypes are: IsTaxExempt, LocalSalesTax, and PurchaseOrderNumber. The following example illustrates how to add a Visa/MasterCard Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 1 TSYSSettle.DetailAggregate[0] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctVisa TSYSLevel2.IsTaxExempt = False TSYSLevel2.LocalSalesTax = "423" // $4.23 TSYSLevel2.PurchaseOrderNumber = "12345678901234567" TSYSSettle.DetailRecords[0].AddendumAggregate = TSYSLevel2.GetAddendum();

If the CardType is tctAmericanExpress, the addendum created will be Group 21 (ODG21). Only the properties prefixed with "Amex" are applicable in this case. These include: AmexCardholderReference, AmexChargeDescriptor, AmexSalesTax, AmexShippedToZip, and AmexSupplierNumber. The following example shows how to add an American Express Level2 addendum to a detail record in the settlement:

TSYSECommerce.Authorize() TSYSSettle.DetailRecordCount = 2 TSYSSettle.DetailAggregate[1] = TSYSECommerce.GetDetailAggregate() TSYSLevel2.CardType = tctAmericanExpress TSYSLevel2.AmexCardholderReference = "INV12345678" TSYSLevel2.AmexChargeDescriptor = "Test transaction" TSYSLevel2.AmexSalesTax = "373" TSYSLevel2.AmexShippedToZip = "90210" TSYSLevel2.AmexSupplierNumber = "SUP244568" TSYSSettle.DetailRecords[1].AddendumAggregate = TSYSLevel2.GetAddendum();

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.

Reset Method (TSYSLevel2 Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

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

Remarks

This method clears all properties to their default values.

Error Handling (C++)

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

Error Event (TSYSLevel2 Class)

Information about errors during data delivery.

Syntax

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

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

  const QString &Description();

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

Remarks

The Error event is fired in case of exceptional conditions during message processing.

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.

Config Settings (TSYSLevel2 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.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

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

TSYSLevel2 Errors

501   Data field invalid length.
502   Data field invalid format.
503   Data field out of range.
592   Invalid or unparseable aggregate.
605   Invalid CardType.