# Zstd Class

TBD.

## Syntax

```text
Zstd
```

## Remarks

TBD

## Property List

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

|  |  |
| --- | --- |
| [CompressionLevel](#compressionlevel-property-zstd-class) | The compression level to use. |
| [InputData](#inputdata-property-zstd-class) | Specifies the data to compress or decompress. |
| [OutputData](#outputdata-property-zstd-class) | The output data after compression or decompression. |

## Method List

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

|  |  |
| --- | --- |
| [CompressBlock](#compressblock-method-zstd-class) | Compresses a block of data. |
| [CompressData](#compressdata-method-zstd-class) | Compresses the specified data. |
| [Config](#config-method-zstd-class) | Sets or retrieves a configuration setting. |
| [DecompressBlock](#decompressblock-method-zstd-class) | Decompresses a block of data. |
| [DecompressData](#decompressdata-method-zstd-class) | Decompresses the specified data. |
| [Reset](#reset-method-zstd-class) | Resets the class. |

## 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.*

|  |  |
| --- | --- |
| [CompressedData](#compresseddata-event-zstd-class) | This event fires with compressed data. |
| [DecompressedData](#decompresseddata-event-zstd-class) | This event fires with decompressed data. |
| [Error](#error-event-zstd-class) | Information 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.*

|  |  |
| --- | --- |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# CompressionLevel Property ([Zstd](#zstd-class) Class)

The compression level to use.

## Syntax

```text
ANSI (Cross Platform)
int GetCompressionLevel();int SetCompressionLevel(int iCompressionLevel);

Unicode (Windows)
INT GetCompressionLevel();INT SetCompressionLevel(INT iCompressionLevel);
```

## Default Value

4

## Remarks

The compression level to use, from 1 to 6. Higher values will cause the component to compress better; lower values will cause the component to compress faster.

When GetCompressionStream is invoked the stream will be created with the specified compression level. After a stream has been created it is independent of the control, and changing CompressionLevel will have no effect on existing streams.

## Data Type

Integer

# InputData Property ([Zstd](#zstd-class) Class)

Specifies the data to compress or decompress.

## Syntax

```text
ANSI (Cross Platform)
int GetInputData(char* &lpInputData, int &lenInputData);int SetInputData(const char* lpInputData, int lenInputData);

Unicode (Windows)
INT GetInputData(LPSTR &lpInputData, INT &lenInputData);INT SetInputData(LPCSTR lpInputData, INT lenInputData);
```

## Default Value

""

## Remarks

This property specifies the data to compress or decompress.

When decompressing this should be set to the compressed data before calling [DecompressData](#decompressdata-method-zstd-class) or [DecompressBlock](#decompressblock-method-zstd-class).

When compressing this should be set to the decompressed data before calling [CompressData](#compressdata-method-zstd-class) or [CompressBlock](#compressblock-method-zstd-class).

When performing operations on multiple chunks of data, note that this property is not automatically cleared after each operation.

## Data Type

Binary String

# OutputData Property ([Zstd](#zstd-class) Class)

The output data after compression or decompression.

## Syntax

```text
ANSI (Cross Platform)
int GetOutputData(char* &lpOutputData, int &lenOutputData);

Unicode (Windows)
INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);
```

## Default Value

""

## Remarks

This property holds the compressed or decompressed data after [CompressData](#compressdata-method-zstd-class) or [DecompressData](#decompressdata-method-zstd-class) is called.

This property is not applicable when calling [CompressBlock](#compressblock-method-zstd-class) or [DecompressBlock](#decompressblock-method-zstd-class).

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

## Data Type

Binary String

# CompressBlock Method ([Zstd](#zstd-class) Class)

Compresses a block of data.

## Syntax

```text
ANSI (Cross Platform)
int CompressBlock(int bLastBlock);

Unicode (Windows)
INT CompressBlock(BOOL bLastBlock);
```

## Remarks

This method compresses the block of data specified by [InputData](#inputdata-property-zstd-class).

The CompressBlock and [DecompressBlock](#decompressblock-method-zstd-class) methods operate on blocks (chunks) of data. The methods may be used to compress and decompress data as it becomes available.

Note that when using blocks of data the [OutputData](#outputdata-property-zstd-class) property is not applicable. Instead data is made available through the [CompressedData](#compresseddata-event-zstd-class) and [DecompressedData](#decompresseddata-event-zstd-class) events.

If all data is available ahead of time [CompressData](#compressdata-method-zstd-class) and [DecompressData](#decompressdata-method-zstd-class) may be called instead.

### Compress Data

Set [InputData](#inputdata-property-zstd-class) to the current block to be compressed. Next call CompressBlock to compress the current block. Note that CompressBlock takes a *LastBlock* parameter. If the block of data is the final block to be compressed set this to True. For all other blocks set this to False.

During compression the [CompressedData](#compresseddata-event-zstd-class) event will fire with the compressed data. Note that this event may not fire for every call to CompressBlock due to the way the compression algorithm operates. For example:

```text
zipstream.InputDataB = MyDecompressedData;
zipstream.CompressBlock();
```

 Data is accumulated inside the [CompressedData](#compresseddata-event-zstd-class) event:

```text
private static void Zipstream_OnCompressedData(object sender, ZipstreamCompressedDataEventArgs e)
{
  DoSomethingWith(e.DataB);
}
```

Note that [OutputData](#outputdata-property-zstd-class) is not applicable when compressing block data.

### Decompress Data

Set [InputData](#inputdata-property-zstd-class) to the current block to be decompressed. Next call [DecompressBlock](#decompressblock-method-zstd-class) to decompress the current block.

During decompression the [DecompressedData](#decompresseddata-event-zstd-class) event will fire with the decompressed data. Note that this event may not fire for every call to [DecompressBlock](#decompressblock-method-zstd-class) due to the way the decompression algorithm operates. For example:

```text
zipstream.InputDataB = MyCompressedData;
zipstream.DecompressBlock();
```

 Data is accumulated inside the [DecompressedData](#decompresseddata-event-zstd-class) event:

```text
private static void Zipstream_OnDecompressedData(object sender, ZipstreamDecompressedDataEventArgs e)
{
  DoSomethingWith(e.DataB);
}
```

Note that [OutputData](#outputdata-property-zstd-class) is not applicable when decompressing block data.

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

# CompressData Method ([Zstd](#zstd-class) Class)

Compresses the specified data.

## Syntax

```text
ANSI (Cross Platform)
int CompressData();

Unicode (Windows)
INT CompressData();
```

## Remarks

This method compresses the data specified by [InputData](#inputdata-property-zstd-class). After calling this method [OutputData](#outputdata-property-zstd-class) holds the compressed data.

The CompressData and [DecompressData](#decompressdata-method-zstd-class) methods operate on the complete blob of data. The entire compressed or decompressed data must be set to [InputData](#inputdata-property-zstd-class) before calling either method.

To compress and decompress data in blocks (chunks) see [CompressBlock](#compressblock-method-zstd-class) and [DecompressBlock](#decompressblock-method-zstd-class).

### Compress Data

Set [InputData](#inputdata-property-zstd-class) to the decompressed data. This should be the entire data to be compressed. Next call CompressData. After compression [OutputData](#outputdata-property-zstd-class) will hold the compressed data. For example:

```text
zipstream.InputDataB = MyDecompressedData;
zipstream.CompressData();
MyCompressedData = zipstream.OutputDataB;
```

In addition to [OutputData](#outputdata-property-zstd-class), the compressed data may also be accumulated within the [CompressedData](#compresseddata-event-zstd-class) event.

### Decompress Data

Set [InputData](#inputdata-property-zstd-class) to the compressed data. This should be the entire data to be decompressed. Next call [DecompressData](#decompressdata-method-zstd-class). After decompression [OutputData](#outputdata-property-zstd-class) will hold the decompressed data. For example:

```text
zipstream.InputDataB = MyCompressedData;
zipstream.DecompressData();
MyDecompressedData = zipstream.OutputDataB;
```

In addition to [OutputData](#outputdata-property-zstd-class), the compressed data may also be accumulated within the [DecompressedData](#decompresseddata-event-zstd-class) event.

## Error Handling (C++)

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

# Config Method ([Zstd](#zstd-class) Class)

Sets or retrieves a configuration setting.

## Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-zstd-class) 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](#config-settings-zstd-class), 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.

# DecompressBlock Method ([Zstd](#zstd-class) Class)

Decompresses a block of data.

## Syntax

```text
ANSI (Cross Platform)
int DecompressBlock();

Unicode (Windows)
INT DecompressBlock();
```

## Remarks

This method decompresses the block of data specified by [InputData](#inputdata-property-zstd-class).

The [CompressBlock](#compressblock-method-zstd-class) and DecompressBlock methods operate on blocks (chunks) of data. The methods may be used to compress and decompress data as it becomes available.

Note that when using blocks of data the [OutputData](#outputdata-property-zstd-class) property is not applicable. Instead data is made available through the [CompressedData](#compresseddata-event-zstd-class) and [DecompressedData](#decompresseddata-event-zstd-class) events.

If all data is available ahead of time [CompressData](#compressdata-method-zstd-class) and [DecompressData](#decompressdata-method-zstd-class) may be called instead.

### Compress Data

Set [InputData](#inputdata-property-zstd-class) to the current block to be compressed. Next call [CompressBlock](#compressblock-method-zstd-class) to compress the current block. Note that [CompressBlock](#compressblock-method-zstd-class) takes a *LastBlock* parameter. If the block of data is the final block to be compressed set this to True. For all other blocks set this to False.

During compression the [CompressedData](#compresseddata-event-zstd-class) event will fire with the compressed data. Note that this event may not fire for every call to [CompressBlock](#compressblock-method-zstd-class) due to the way the compression algorithm operates. For example:

```text
zipstream.InputDataB = MyDecompressedData;
zipstream.CompressBlock();
```

 Data is accumulated inside the [CompressedData](#compresseddata-event-zstd-class) event:

```text
private static void Zipstream_OnCompressedData(object sender, ZipstreamCompressedDataEventArgs e)
{
  DoSomethingWith(e.DataB);
}
```

Note that [OutputData](#outputdata-property-zstd-class) is not applicable when compressing block data.

### Decompress Data

Set [InputData](#inputdata-property-zstd-class) to the current block to be decompressed. Next call DecompressBlock to decompress the current block.

During decompression the [DecompressedData](#decompresseddata-event-zstd-class) event will fire with the decompressed data. Note that this event may not fire for every call to DecompressBlock due to the way the decompression algorithm operates. For example:

```text
zipstream.InputDataB = MyCompressedData;
zipstream.DecompressBlock();
```

 Data is accumulated inside the [DecompressedData](#decompresseddata-event-zstd-class) event:

```text
private static void Zipstream_OnDecompressedData(object sender, ZipstreamDecompressedDataEventArgs e)
{
  DoSomethingWith(e.DataB);
}
```

Note that [OutputData](#outputdata-property-zstd-class) is not applicable when decompressing block data.

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

# DecompressData Method ([Zstd](#zstd-class) Class)

Decompresses the specified data.

## Syntax

```text
ANSI (Cross Platform)
int DecompressData();

Unicode (Windows)
INT DecompressData();
```

## Remarks

This method decompresses the data specified by [InputData](#inputdata-property-zstd-class). After calling this method [OutputData](#outputdata-property-zstd-class) holds the decompressed data.

The [CompressData](#compressdata-method-zstd-class) and DecompressData methods operate on the complete blob of data. The entire compressed or decompressed data must be set to [InputData](#inputdata-property-zstd-class) before calling either method.

To compress and decompress data in blocks (chunks) see [CompressBlock](#compressblock-method-zstd-class) and [DecompressBlock](#decompressblock-method-zstd-class).

### Compress Data

Set [InputData](#inputdata-property-zstd-class) to the decompressed data. This should be the entire data to be compressed. Next call [CompressData](#compressdata-method-zstd-class). After compression [OutputData](#outputdata-property-zstd-class) will hold the compressed data. For example:

```text
zipstream.InputDataB = MyDecompressedData;
zipstream.CompressData();
MyCompressedData = zipstream.OutputDataB;
```

In addition to [OutputData](#outputdata-property-zstd-class), the compressed data may also be accumulated within the [CompressedData](#compresseddata-event-zstd-class) event.

### Decompress Data

Set [InputData](#inputdata-property-zstd-class) to the compressed data. This should be the entire data to be decompressed. Next call DecompressData. After decompression [OutputData](#outputdata-property-zstd-class) will hold the decompressed data. For example:

```text
zipstream.InputDataB = MyCompressedData;
zipstream.DecompressData();
MyDecompressedData = zipstream.OutputDataB;
```

In addition to [OutputData](#outputdata-property-zstd-class), the compressed data may also be accumulated within the [DecompressedData](#decompresseddata-event-zstd-class) event.

## 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 ([Zstd](#zstd-class) Class)

Resets the class.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
```

## Remarks

Reset resets the state of the class. All properties will be set to their default values, and any files open will be closed.

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

# CompressedData Event ([Zstd](#zstd-class) Class)

This event fires with compressed data.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCompressedData(ZstdCompressedDataEventParams *e);
typedef struct {  const char *Data;
  int lenData;
  int reserved;
} ZstdCompressedDataEventParams;

Unicode (Windows)
virtual INT FireCompressedData(ZstdCompressedDataEventParams *e);
typedef struct {  LPCSTR Data;
  INT lenData;
  INT reserved;
} ZstdCompressedDataEventParams;
```

## Remarks

The CompressedData event fires as compressed data is available when [CompressData](#compressdata-method-zstd-class) or [CompressBlock](#compressblock-method-zstd-class) is called. This may fire one or more times when data is compressed.

*Data* holds the current block of compressed data.

# DecompressedData Event ([Zstd](#zstd-class) Class)

This event fires with decompressed data.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDecompressedData(ZstdDecompressedDataEventParams *e);
typedef struct {  const char *Data;
  int lenData;
  int reserved;
} ZstdDecompressedDataEventParams;

Unicode (Windows)
virtual INT FireDecompressedData(ZstdDecompressedDataEventParams *e);
typedef struct {  LPCSTR Data;
  INT lenData;
  INT reserved;
} ZstdDecompressedDataEventParams;
```

## Remarks

The DecompressedData event fires as compressed data is available when [DecompressData](#decompressdata-method-zstd-class) or [DecompressBlock](#decompressblock-method-zstd-class) is called. This may fire one or more times as data is decompressed.

*Data* holds the current block of decompressed data.

# Error Event ([Zstd](#zstd-class) Class)

Information about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(ZstdErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} ZstdErrorEventParams;

Unicode (Windows)
virtual INT FireError(ZstdErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} ZstdErrorEventParams;
```

## 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](#trappable-errors-zstd-class) section.

# Config Settings ([Zstd](#zstd-class) 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](#config-method-zstd-class) method.

*No configuration settings defined.*

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

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

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

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

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

**MaskSensitiveData**: 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*.

**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](platforms.md) section.

# Trappable Errors ([Zstd](#zstd-class) 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.

 Note that the streams returned by GetCompressionStream and GetDecompressionStream will throw standard IOExceptions in case of error.

### ZipStream Errors

|  |  |
| --- | --- |
| 101 | The data is of an invalid or unsupported format. |
| 111 | Can't open file for read. |
| 150 | An I/O error has occurred (details follow). |