--- product: Chilkat product_version: 11.7.0 language: dataflex language_label: DataFlex class: Zip license: bundle deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/dataflexZipRef.html --- # Chilkat Zip — DataFlex — v11.7.0 > Chilkat 11.7.0 · language=dataflex · class=Zip > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/Zip.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/guide.md`. ## Purpose **Create, read, modify, encrypt, and extract ZIP archives.** `Chilkat.Zip` provides a comprehensive API for working with ZIP archives from files, memory, `BinData`, embedded resources, and Windows self-extracting EXEs. It can create new archives, open existing ZIPs, add files or in-memory data, inspect entries, extract selectively, and write the final archive to disk or memory. **Create ZIP archives** Add files, directories, strings, byte arrays, `BinData`, and `StringBuilder` content. **Open ZIPs from many sources** Open archives from disk, memory, `BinData`, embedded Windows resources, or Chilkat-created self-extracting EXEs. **Control stored paths** Use options such as `AppendFromDir`, `DiscardPaths`, `PathPrefix`, and `saveExtraPath`. **Extract selectively** Extract all files, matching entries, newer files, or flatten all output into a single directory. **Encryption support** Work with WinZip-compatible AES encryption and legacy Zip 2.0 password protection. **Large archive support** ZIP64 is used automatically when older ZIP limits are exceeded. **Important:** Many methods update the in-memory ZIP object first. The archive is not written until a method such as `WriteZip`, `WriteZipAndClose`, `WriteBd`, or `WriteToMemory` is called. For an extended overview, see [Zip Class Overview](https://www.chilkatsoft.com/zip_class_overview.asp). ## Object creation, unlocking and error handling **Object Creation** ```dataflex // (Dataflex programs use the 32-bit Chilkat ActiveX) Handle hoZip Get Create(RefClass(cComChilkatZip)) to hoZip ``` Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in DataFlex. How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `Function ComDebugLogFilePath Returns String Procedure Set ComDebugLogFilePath String value` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastBinaryResult` | `Function ComLastBinaryResult Returns Variant` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. | | `LastErrorHtml` | `Function ComLastErrorHtml Returns String` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `Function ComLastErrorText Returns String` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `Function ComLastErrorXml Returns String` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `Function ComLastMethodSuccess Returns Boolean Procedure Set ComLastMethodSuccess Boolean value` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `LastStringResult` | `Function ComLastStringResult Returns String` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. | | `LastStringResultLen` | `Function ComLastStringResultLen Returns Integer` | read-only | The length, in characters, of the string contained in the LastStringResult property. | | `VerboseLogging` | `Function ComVerboseLogging Returns Boolean Procedure Set ComVerboseLogging Boolean value` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `Function ComVersion Returns String` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `AbortCurrent` | property, read/write | `Function ComAbortCurrent Returns Boolean Procedure Set ComAbortCurrent Boolean value` | | `AppendFromDir` | property, read/write | `Function ComAppendFromDir Returns String Procedure Set ComAppendFromDir String value` | | `AutoRun` | property, read/write | `Function ComAutoRun Returns String Procedure Set ComAutoRun String value` | | `AutoRunParams` | property, read/write | `Function ComAutoRunParams Returns String Procedure Set ComAutoRunParams String value` | | `AutoTemp` | property, read/write | `Function ComAutoTemp Returns Boolean Procedure Set ComAutoTemp Boolean value` | | `CaseSensitive` | property, read/write | `Function ComCaseSensitive Returns Boolean Procedure Set ComCaseSensitive Boolean value` | | `ClearArchiveAttribute` | property, read/write | `Function ComClearArchiveAttribute Returns Boolean Procedure Set ComClearArchiveAttribute Boolean value` | | `ClearReadOnlyAttr` | property, read/write | `Function ComClearReadOnlyAttr Returns Boolean Procedure Set ComClearReadOnlyAttr Boolean value` | | `Comment` | property, read/write | `Function ComComment Returns String Procedure Set ComComment String value` | | `DecryptPassword` | property, read/write | `Function ComDecryptPassword Returns String Procedure Set ComDecryptPassword String value` | | `DiscardPaths` | property, read/write | `Function ComDiscardPaths Returns Boolean Procedure Set ComDiscardPaths Boolean value` | | `Encryption` | property, read/write | `Function ComEncryption Returns Integer Procedure Set ComEncryption Integer value` | | `EncryptKeyLength` | property, read/write | `Function ComEncryptKeyLength Returns Integer Procedure Set ComEncryptKeyLength Integer value` | | `EncryptPassword` | property, read/write | `Function ComEncryptPassword Returns String Procedure Set ComEncryptPassword String value` | | `ExeDefaultDir` | property, read/write | `Function ComExeDefaultDir Returns String Procedure Set ComExeDefaultDir String value` | | `ExeFinishNotifier` | property, read/write | `Function ComExeFinishNotifier Returns Boolean Procedure Set ComExeFinishNotifier Boolean value` | | `ExeIconFile` | property, read/write | `Function ComExeIconFile Returns String Procedure Set ComExeIconFile String value` | | `ExeNoInterface` | property, read/write | `Function ComExeNoInterface Returns Boolean Procedure Set ComExeNoInterface Boolean value` | | `ExeSilentProgress` | property, read/write | `Function ComExeSilentProgress Returns Boolean Procedure Set ComExeSilentProgress Boolean value` | | `ExeTitle` | property, read/write | `Function ComExeTitle Returns String Procedure Set ComExeTitle String value` | | `ExeUnzipCaption` | property, read/write | `Function ComExeUnzipCaption Returns String Procedure Set ComExeUnzipCaption String value` | | `ExeUnzipDir` | property, read/write | `Function ComExeUnzipDir Returns String Procedure Set ComExeUnzipDir String value` | | `ExeWaitForSetup` | property, read/write | `Function ComExeWaitForSetup Returns Boolean Procedure Set ComExeWaitForSetup Boolean value` | | `ExeXmlConfig` | property, read/write | `Function ComExeXmlConfig Returns String Procedure Set ComExeXmlConfig String value` | | `FileCount` | property, read-only | `Function ComFileCount Returns Integer` | | `FileName` | property, read/write | `Function ComFileName Returns String Procedure Set ComFileName String value` | | `HasZipFormatErrors` | property, read-only | `Function ComHasZipFormatErrors Returns Boolean` | | `IgnoreAccessDenied` | property, read/write | `Function ComIgnoreAccessDenied Returns Boolean Procedure Set ComIgnoreAccessDenied Boolean value` | | `MaxDate` | property, read/write | `Function ComMaxDate Returns String Procedure Set ComMaxDate String value` | | `MaxUncompressSize` | property, read/write | `Function ComMaxUncompressSize Returns Integer Procedure Set ComMaxUncompressSize Integer value` | | `MinDate` | property, read/write | `Function ComMinDate Returns String Procedure Set ComMinDate String value` | | `NumEntries` | property, read-only | `Function ComNumEntries Returns Integer` | | `OemCodePage` | property, read/write | `Function ComOemCodePage Returns Integer Procedure Set ComOemCodePage Integer value` | | `OverwriteExisting` | property, read/write | `Function ComOverwriteExisting Returns Boolean Procedure Set ComOverwriteExisting Boolean value` | | `PasswordProtect` | property, read/write | `Function ComPasswordProtect Returns Boolean Procedure Set ComPasswordProtect Boolean value` | | `PathPrefix` | property, read/write | `Function ComPathPrefix Returns String Procedure Set ComPathPrefix String value` | | `PwdProtCharset` | property, read/write | `Function ComPwdProtCharset Returns String Procedure Set ComPwdProtCharset String value` | | `TempDir` | property, read/write | `Function ComTempDir Returns String Procedure Set ComTempDir String value` | | `UncommonOptions` | property, read/write | `Function ComUncommonOptions Returns String Procedure Set ComUncommonOptions String value` | | `Zipx` | property, read/write | `Function ComZipx Returns Boolean Procedure Set ComZipx Boolean value` | | `ZipxDefaultAlg` | property, read/write | `Function ComZipxDefaultAlg Returns String Procedure Set ComZipxDefaultAlg String value` | | `AddBd` | method | `Function ComAddBd String pathInZip cComChilkatBinData bd Returns Boolean` | | `AddEmpty` | method | `Function ComAddEmpty Boolean isDir String pathInZip Returns Boolean` | | `AddEncoded` | method | `Function ComAddEncoded String pathInZip String encoding String data Returns Boolean` | | `AddFile` | method | `Function ComAddFile String localPath Boolean saveExtraPath Returns Boolean` | | `AddNoCompressExtension` | method | `Procedure ComAddNoCompressExtension String fileExtension` | | `AddSb` | method | `Function ComAddSb String pathInZip cComChilkatStringBuilder sb String charset Returns Boolean` | | `AddString` | method | `Function ComAddString String pathInZip String content String charset Returns Boolean` | | `AppendFiles` | method | `Function ComAppendFiles String filePattern Boolean recurse Returns Boolean` | | `AppendFilesEx` | method | `Function ComAppendFilesEx String filePattern Boolean recurse Boolean saveExtraPath Boolean archiveOnly Boolean includeHidden Boolean includeSystem Returns Boolean` | | `AppendZip` | method | `Function ComAppendZip String zipPath Returns Boolean` | | `CloseZip` | method | `Procedure ComCloseZip` | | `DeleteEntry` | method | `Function ComDeleteEntry cComChilkatZipEntry entry Returns Boolean` | | `EntryAt` | method | `Function ComEntryAt Integer index cComChilkatZipEntry entry Returns Boolean` | | `EntryById` | method | `Function ComEntryById Integer id cComChilkatZipEntry entry Returns Boolean` | | `EntryMatching` | method | `Function ComEntryMatching String pattern cComChilkatZipEntry entry Returns Boolean` | | `EntryOf` | method | `Function ComEntryOf String pathInZip cComChilkatZipEntry entry Returns Boolean` | | `ExcludeDir` | method | `Procedure ComExcludeDir String dirName` | | `ExtractExe` | method | `Function ComExtractExe String exePath String dirPath Returns Boolean` | | `GetDirectoryAsXML` | method | `Function ComGetDirectoryAsXML Returns String` | | `GetExeConfigParam` | method | `Function ComGetExeConfigParam String name Returns String` | | `GetMaxUncompressedSize` | method | `Function ComGetMaxUncompressedSize Returns String` | | `IsNoCompressExtension` | method | `Function ComIsNoCompressExtension String fileExtension Returns Boolean` | | `IsPasswordProtected` | method | `Function ComIsPasswordProtected String zipPath Returns Boolean` | | `LoadTaskCaller` | method | `Function ComLoadTaskCaller cComChilkatTask task Returns Boolean` | | `NewZip` | method | `Function ComNewZip String zipPath Returns Boolean` | | `OpenBd` | method | `Function ComOpenBd cComChilkatBinData binData Returns Boolean` | | `OpenEmbedded` | method | `Function ComOpenEmbedded String exeFilename String resourceName Returns Boolean` | | `OpenFromByteData` | method | `Function ComOpenFromByteData Variant byteData Returns Boolean` | | `OpenFromMemory` | method | `Function ComOpenFromMemory Variant inData Returns Boolean` | | `OpenZip` | method | `Function ComOpenZip String zipPath Returns Boolean` | | `QuickAppend` | method | `Function ComQuickAppend String zipPath Returns Boolean` | | `RemoveNoCompressExtension` | method | `Procedure ComRemoveNoCompressExtension String fileExtension` | | `SetCompressionLevel` | method | `Procedure ComSetCompressionLevel Integer level` | | `SetExclusions` | method | `Procedure ComSetExclusions cComCkStringArray excludePatterns` | | `SetExeConfigParam` | method | `Procedure ComSetExeConfigParam String paramName String paramValue` | | `Unzip` | method | `Function ComUnzip String dirPath Returns Integer` | | `UnzipInto` | method | `Function ComUnzipInto String dirPath Returns Integer` | | `UnzipMatching` | method | `Function ComUnzipMatching String dirPath String pattern Boolean verbose Returns Integer` | | `UnzipMatchingInto` | method | `Function ComUnzipMatchingInto String dirPath String pattern Boolean verbose Returns Integer` | | `UnzipNewer` | method | `Function ComUnzipNewer String dirPath Returns Integer` | | `VerifyPassword` | method | `Function ComVerifyPassword Returns Boolean` | | `WriteBd` | method | `Function ComWriteBd cComChilkatBinData binData Returns Boolean` | | `WriteExe` | method | `Function ComWriteExe String exeFilename Returns Boolean` | | `WriteExeToMemory` | method | `Function ComWriteExeToMemory Returns Variant` | | `WriteToMemory` | method | `Function ComWriteToMemory Returns Variant` | | `WriteZip` | method | `Function ComWriteZip Returns Boolean` | | `WriteZipAndClose` | method | `Function ComWriteZipAndClose Returns Boolean` | Deprecated members are listed at the end of this file with their replacements; do not use them in new code. ## Properties ### Zip.AbortCurrent `Chilkat 11.7.0 · dataflex · Zip · AbortCurrent · property · read/write · since 9.5.0.58` ```dataflex Function ComAbortCurrent Returns Boolean Procedure Set ComAbortCurrent Boolean value ``` Stops the currently executing operation when set to `True`. - Used to cancel long-running operations such as compression or extraction. - Can be triggered from another thread. - Automatically resets to `False` after the operation stops. ### Zip.AppendFromDir `Chilkat 11.7.0 · dataflex · Zip · AppendFromDir · property · read/write` ```dataflex Function ComAppendFromDir Returns String Procedure Set ComAppendFromDir String value ``` Specifies a base directory when adding files to the ZIP. - This portion of the path is **not included** in stored ZIP entry paths. - Useful for controlling relative paths inside the archive. For example, to add all files under `c:/abc/123/myAppDir`, this property could be set to `c:/abc/123`, and `myAppDir/*` would be passed to `AppendFiles`. The path stored in the ZIP would begin with `myAppDir/`. ### Zip.AutoRun `Chilkat 11.7.0 · dataflex · Zip · AutoRun · property · read/write` ```dataflex Function ComAutoRun Returns String Procedure Set ComAutoRun String value ``` `(Windows only, for creating self-extracting EXE's)` Specifies the name of an executable inside a self-extracting EXE that runs automatically after extraction. ### Zip.AutoRunParams `Chilkat 11.7.0 · dataflex · Zip · AutoRunParams · property · read/write` ```dataflex Function ComAutoRunParams Returns String Procedure Set ComAutoRunParams String value ``` `(Windows only, for creating self-extracting EXE's)` Command-line arguments passed to the `AutoRun` executable. ### Zip.AutoTemp `Chilkat 11.7.0 · dataflex · Zip · AutoTemp · property · read/write` ```dataflex Function ComAutoTemp Returns Boolean Procedure Set ComAutoTemp Boolean value ``` `(Windows only, for creating self-extracting EXE's)` If `True`, the EXE being created will automatically select and create a temporary directory for unzipping. This property is often used together with `AutoRun` to create a self-extracting EXE that automatically unzips to a temporary directory and runs a setup program, such as `setup.exe`, without user interaction. **Note:** To create a self-extracting EXE with no user interaction, set the following properties: > `ExeSilentProgress = False` > `ExeNoInterface = True` > `ExeFinishNotifier = False` The default value is `False`. ### Zip.CaseSensitive `Chilkat 11.7.0 · dataflex · Zip · CaseSensitive · property · read/write` ```dataflex Function ComCaseSensitive Returns Boolean Procedure Set ComCaseSensitive Boolean value ``` Controls whether filename matching is case-sensitive. - Affects methods such as `EntryMatching` and `UnzipMatching`. - Default: `False` ### Zip.ClearArchiveAttribute `Chilkat 11.7.0 · dataflex · Zip · ClearArchiveAttribute · property · read/write` ```dataflex Function ComClearArchiveAttribute Returns Boolean Procedure Set ComClearArchiveAttribute Boolean value ``` `(Windows only)` If `True`, clears the Windows archive attribute after files are successfully added to the ZIP. The archive attribute indicates that a file has changed since the last backup. The default value is `False`. ### Zip.ClearReadOnlyAttr `Chilkat 11.7.0 · dataflex · Zip · ClearReadOnlyAttr · property · read/write` ```dataflex Function ComClearReadOnlyAttr Returns Boolean Procedure Set ComClearReadOnlyAttr Boolean value ``` If `True`, removes the read-only attribute from extracted files. If `False`, the read-only attribute remains unchanged. The default value is `False`. ### Zip.Comment `Chilkat 11.7.0 · dataflex · Zip · Comment · property · read/write` ```dataflex Function ComComment Returns String Procedure Set ComComment String value ``` Sets or retrieves the global ZIP file comment. The default value is the empty string. ### Zip.DecryptPassword `Chilkat 11.7.0 · dataflex · Zip · DecryptPassword · property · read/write` ```dataflex Function ComDecryptPassword Returns String Procedure Set ComDecryptPassword String value ``` Password used to extract encrypted ZIP archives. - Required to unzip encrypted entries. - Encrypted ZIP files may still be opened without a password, but their contents cannot be extracted until the correct password is provided. The default value is the empty string. ### Zip.DiscardPaths `Chilkat 11.7.0 · dataflex · Zip · DiscardPaths · property · read/write` ```dataflex Function ComDiscardPaths Returns Boolean Procedure Set ComDiscardPaths Boolean value ``` If `True`, removes all directory path information when adding files. Only filenames are stored in the ZIP. The default value is `False`. ### Zip.Encryption `Chilkat 11.7.0 · dataflex · Zip · Encryption · property · read/write` ```dataflex Function ComEncryption Returns Integer Procedure Set ComEncryption Integer value ``` Specifies encryption mode: - `0` → No encryption - `4` → WinZip-compatible AES encryption **Important:** `Encryption` and `PasswordProtect` are mutually exclusive. If `PasswordProtect = True`, then `Encryption` should be `0`. The default value is `0`. ### Zip.EncryptKeyLength `Chilkat 11.7.0 · dataflex · Zip · EncryptKeyLength · property · read/write` ```dataflex Function ComEncryptKeyLength Returns Integer Procedure Set ComEncryptKeyLength Integer value ``` Specifies the AES encryption key length. - Valid values: `128`, `192`, or `256` The default value is `128`. ### Zip.EncryptPassword `Chilkat 11.7.0 · dataflex · Zip · EncryptPassword · property · read/write` ```dataflex Function ComEncryptPassword Returns String Procedure Set ComEncryptPassword String value ``` Password used when creating encrypted ZIP archives. The default value is the empty string. ### Zip.ExeDefaultDir `Chilkat 11.7.0 · dataflex · Zip · ExeDefaultDir · property · read/write` ```dataflex Function ComExeDefaultDir Returns String Procedure Set ComExeDefaultDir String value ``` `(Windows only, for creating self-extracting EXE's)` Default extraction directory shown in the self-extracting EXE user interface. The default value is the empty string. ### Zip.ExeFinishNotifier `Chilkat 11.7.0 · dataflex · Zip · ExeFinishNotifier · property · read/write` ```dataflex Function ComExeFinishNotifier Returns Boolean Procedure Set ComExeFinishNotifier Boolean value ``` `(Windows only, for creating self-extracting EXE's)` If `True`, displays a completion dialog after extraction finishes. The default value is `False`. ### Zip.ExeIconFile `Chilkat 11.7.0 · dataflex · Zip · ExeIconFile · property · read/write` ```dataflex Function ComExeIconFile Returns String Procedure Set ComExeIconFile String value ``` `(Windows only, for creating self-extracting EXE's)` Path to an `.ico` file used as the EXE icon. This feature is only available when the application creating the EXE is 32-bit. The default value is the empty string. ### Zip.ExeNoInterface `Chilkat 11.7.0 · dataflex · Zip · ExeNoInterface · property · read/write` ```dataflex Function ComExeNoInterface Returns Boolean Procedure Set ComExeNoInterface Boolean value ``` `(Windows only, for creating self-extracting EXE's)` If `True`, runs the self-extracting EXE without displaying the main user interface. The default value is `False`. ### Zip.ExeSilentProgress `Chilkat 11.7.0 · dataflex · Zip · ExeSilentProgress · property · read/write` ```dataflex Function ComExeSilentProgress Returns Boolean Procedure Set ComExeSilentProgress Boolean value ``` `(Windows only, for creating self-extracting EXE's)` Controls whether a progress dialog is shown during extraction. If `ExeNoInterface = False`, the progress bar appears within the main dialog and this property has no effect. The default value is `False`. ### Zip.ExeTitle `Chilkat 11.7.0 · dataflex · Zip · ExeTitle · property · read/write` ```dataflex Function ComExeTitle Returns String Procedure Set ComExeTitle String value ``` `(Windows only, for creating self-extracting EXE's)` Title displayed in the self-extracting EXE dialog. The default value is the empty string. ### Zip.ExeUnzipCaption `Chilkat 11.7.0 · dataflex · Zip · ExeUnzipCaption · property · read/write` ```dataflex Function ComExeUnzipCaption Returns String Procedure Set ComExeUnzipCaption String value ``` `(Windows only, for creating self-extracting EXE's)` Caption text displayed in the self-extracting EXE dialog. The default value is the empty string. ### Zip.ExeUnzipDir `Chilkat 11.7.0 · dataflex · Zip · ExeUnzipDir · property · read/write` ```dataflex Function ComExeUnzipDir Returns String Procedure Set ComExeUnzipDir String value ``` `(Windows only, for creating self-extracting EXE's)` Specifies a predefined extraction directory. - Supports environment variables such as `%TEMP%`. - UNC paths are not supported. The default value is the empty string. ### Zip.ExeWaitForSetup `Chilkat 11.7.0 · dataflex · Zip · ExeWaitForSetup · property · read/write` ```dataflex Function ComExeWaitForSetup Returns Boolean Procedure Set ComExeWaitForSetup Boolean value ``` If `True`, waits for the AutoRun executable to finish before exiting. If `False`, the self-extracting EXE may exit before the AutoRun executable completes. The default value is `True`. ### Zip.ExeXmlConfig `Chilkat 11.7.0 · dataflex · Zip · ExeXmlConfig · property · read/write` ```dataflex Function ComExeXmlConfig Returns String Procedure Set ComExeXmlConfig String value ``` Allows for an XML config document to be used to specify all possible options for self-extracting EXEs. This property is a string containing the XML config document. The XML should have this format: \ \Title for incorrect password dialog\ \Caption for incorrect password dialog\ \Text on finish notifier button\ \Text on password challenge dialog's "OK" button.\ \Text on password challenge dialog's Cancel button.\ \Incorrect password error message.\ \Text on main dialog's unzip button. **Note:** The `MainUnzipLabel` must also be set for this to take effect.\ \Text on main dialog's quit/exit button. **Note:** The `MainUnzipLabel` must also be set for this to take effect.\ \Text on main dialog's browse-for-directory button. **Note:** The `MainUnzipLabel` must also be set for this to take effect.\ \Caption displayed in main dialog.\ \0 or 1 (Maps to the `AutoTemp` property)\ \0 or 1 (If 1, extracted files are deleted after the `SetupExe` is run.)\ \0 or 1 (If 1, the EXE will not extract any files.)\ \0 or 1 (If 1, verbose information is written to the log.)\ \0 or 1 (Maps to the `ExeFinishNotifier` property)\ \0 or 1 (Maps to the `ExeNoInterface` property)\ \0 or 1 (Maps to the `ExeSilentProgress` property)\ \0 or 1 (Maps to the `ExeWaitForSetup` property)\ \0 or 1 (1 = Yes, 0 = No)\ \128\|192\|256\ \EXE to run after extracting. (Maps to the `AutoRun` property)\ \Pre-defined unzip directory. (Maps to the `ExeUnzipDir` property. UNC paths, such as \\\\servername\\path, are not supported.)\ \Default unzip directory to appear in the main dialog. (Maps to the `ExeDefaultDir` property)\ \Icon file to be used (Maps to the `ExeIconFile` property)\ \Maps to the `ExeTitle` property.\ \Maps to the `ExeUnzipCaption` property.\ \Title for the finish notifier dialog.\ \Caption for the finish notifier dialog.\ \Title for the progress dialog.\ \Caption for the progress dialog.\ \Title for the password challenge dialog.\ \Caption for the password challenge dialog.\ \ A self-extracting EXE can be run from the command line with the `-log {logFilePath}` option to create a log with information for debugging. ### Zip.FileCount `Chilkat 11.7.0 · dataflex · Zip · FileCount · property · read-only` ```dataflex Function ComFileCount Returns Integer ``` Number of files in the ZIP, excluding directory entries. ### Zip.FileName `Chilkat 11.7.0 · dataflex · Zip · FileName · property · read/write` ```dataflex Function ComFileName Returns String Procedure Set ComFileName String value ``` Path of the ZIP file to be written or overwritten. The default value is the empty string. ### Zip.HasZipFormatErrors `Chilkat 11.7.0 · dataflex · Zip · HasZipFormatErrors · property · read-only` ```dataflex Function ComHasZipFormatErrors Returns Boolean ``` Indicates whether minor ZIP format problems were detected when opening the ZIP archive. ### Zip.IgnoreAccessDenied `Chilkat 11.7.0 · dataflex · Zip · IgnoreAccessDenied · property · read/write` ```dataflex Function ComIgnoreAccessDenied Returns Boolean Procedure Set ComIgnoreAccessDenied Boolean value ``` If `True`, files that cannot be read, written, or created due to filesystem permission errors are skipped. If `False`, any access-denied error causes the ZIP operation to fail. The default value is `True`. ### Zip.MaxDate `Chilkat 11.7.0 · dataflex · Zip · MaxDate · property · read/write · since 10.0.0` ```dataflex Function ComMaxDate Returns String Procedure Set ComMaxDate String value ``` Maximum last-modified timestamp for files processed during add or extract operations. Files having modification timestamps later than this value are skipped. Supports ISO 8601 date/time formats, including: - `YYYY-MM-DD` Example: `2024-07-31` - `YYYY-MM-DDTHH:MM:SS±HH:MM` Example: `2024-07-31T12:34:56+02:00` - `YYYY-MM-DDTHH:MM:SSZ` Example: `2024-07-31T12:34:56Z` The default value is the empty string, meaning no maximum date restriction. ### Zip.MaxUncompressSize `Chilkat 11.7.0 · dataflex · Zip · MaxUncompressSize · property · read/write · since 9.5.0.96` ```dataflex Function ComMaxUncompressSize Returns Integer Procedure Set ComMaxUncompressSize Integer value ``` Prevents extraction of files larger than the specified uncompressed size. A value of `0` means no size limit. The default value is `0`. ### Zip.MinDate `Chilkat 11.7.0 · dataflex · Zip · MinDate · property · read/write · since 10.0.0` ```dataflex Function ComMinDate Returns String Procedure Set ComMinDate String value ``` Minimum last-modified timestamp for files processed during add or extract operations. Supports ISO 8601 date/time formats, including: - `YYYY-MM-DD` Example: `2024-07-31` - `YYYY-MM-DDTHH:MM:SS±HH:MM` Example: `2024-07-31T12:34:56+02:00` - `YYYY-MM-DDTHH:MM:SSZ` Example: `2024-07-31T12:34:56Z` The default value is the empty string, meaning no minimum date restriction. ### Zip.NumEntries `Chilkat 11.7.0 · dataflex · Zip · NumEntries · property · read-only` ```dataflex Function ComNumEntries Returns Integer ``` Total number of entries in the ZIP, including both files and directories. ### Zip.OemCodePage `Chilkat 11.7.0 · dataflex · Zip · OemCodePage · property · read/write` ```dataflex Function ComOemCodePage Returns Integer Procedure Set ComOemCodePage Integer value ``` Specifies the OEM code page used for ZIP filename encoding. Defaults to the OEM code page of the current computer. ### Zip.OverwriteExisting `Chilkat 11.7.0 · dataflex · Zip · OverwriteExisting · property · read/write` ```dataflex Function ComOverwriteExisting Returns Boolean Procedure Set ComOverwriteExisting Boolean value ``` If `True`, existing files are overwritten during extraction. The default value is `True`. ### Zip.PasswordProtect `Chilkat 11.7.0 · dataflex · Zip · PasswordProtect · property · read/write` ```dataflex Function ComPasswordProtect Returns Boolean Procedure Set ComPasswordProtect Boolean value ``` Indicates whether the ZIP uses legacy Zip 2.0 password protection. This property is set automatically when a ZIP archive is opened by any of the `Open*` methods, such as `OpenZip`, `OpenFromMemory`, `OpenBd`, and related methods. **Important:** `PasswordProtect` and `Encryption` are mutually exclusive. If `PasswordProtect = True`, then `Encryption` should be `0`. The default value is `False`. ### Zip.PathPrefix `Chilkat 11.7.0 · dataflex · Zip · PathPrefix · property · read/write` ```dataflex Function ComPathPrefix Returns String Procedure Set ComPathPrefix String value ``` Gets or sets a path prefix that is prepended to ZIP entry paths for files appended from the local filesystem. This is useful when you want all extracted files to appear under a specific subdirectory. This property affects only the following methods: - `AppendFiles` - `AppendFilesEx` - `AddFile` - `AppendOneFileOrDir` The `PathPrefix` value is prepended to the stored ZIP path for each appended filesystem file. For example, set PathPrefix to subdir/ so that files are stored in the ZIP with subdir/ prepended to their paths. When extracted, the files will be placed under the subdir directory. This property does not affect entries added entirely from memory, such as entries added using: - `AddString` - `AddData` - `AddBd` - `AddSb` For in-memory entries, the ZIP entry path is determined solely by the filename/path argument passed to the method. The default value is the empty string. ### Zip.PwdProtCharset `Chilkat 11.7.0 · dataflex · Zip · PwdProtCharset · property · read/write · since 9.5.0.73` ```dataflex Function ComPwdProtCharset Returns String Procedure Set ComPwdProtCharset String value ``` Specifies the character encoding used to convert the decrypt password into its binary byte representation for legacy password-protected ZIP archives that use Zip 2.0 encryption. The default value is `ansi`. Other possible values include: - `cp850` - `cp437` - Any supported Windows or OEM code page listed at the link below. This property applies only to older Zip 2.0 password protection and is not used for AES-encrypted ZIP archives. ### Zip.TempDir `Chilkat 11.7.0 · dataflex · Zip · TempDir · property · read/write` ```dataflex Function ComTempDir Returns String Procedure Set ComTempDir String value ``` Directory used for temporary files during ZIP operations. When overwriting an existing ZIP file, a temporary file is used to avoid corrupting the original ZIP if an error occurs. The default value depends on the runtime environment. ### Zip.UncommonOptions `Chilkat 11.7.0 · dataflex · Zip · UncommonOptions · property · read/write · since 9.5.0.84` ```dataflex Function ComUncommonOptions Returns String Procedure Set ComUncommonOptions String value ``` Advanced options for uncommon scenarios. - `ForceZip64` → Forces ZIP64 format even when not required. The default value is the empty string. ### Zip.Zipx `Chilkat 11.7.0 · dataflex · Zip · Zipx · property · read/write` ```dataflex Function ComZipx Returns Boolean Procedure Set ComZipx Boolean value ``` If `True`, creates ZIPX archives using the most appropriate compression method for each file. The default value is `False`. ### Zip.ZipxDefaultAlg `Chilkat 11.7.0 · dataflex · Zip · ZipxDefaultAlg · property · read/write` ```dataflex Function ComZipxDefaultAlg Returns String Procedure Set ComZipxDefaultAlg String value ``` Default compression algorithm used when creating ZIPX archives. - Possible values include: - `deflate` - `ppmd` - `lzma` - `bzip2` - `deflate64` The default value is `deflate`. ## Methods ### Zip.AddBd `Chilkat 11.7.0 · dataflex · Zip · AddBd · method · since 11.0.0` ```dataflex Function ComAddBd String pathInZip cComChilkatBinData bd Returns Boolean ``` Adds the contents of a `BinData` object as a new entry in the ZIP archive. - `pathInZip` specifies the filename and optional directory path stored within the ZIP. - The bytes contained in `bd` become the contents of the ZIP entry. - The entry is added to the in-memory ZIP object and is not written to disk until `WriteZip`, `WriteZipAndClose`, `WriteBd`, or `WriteToMemory` is called. Returns True for success, False for failure. ### Zip.AddEmpty `Chilkat 11.7.0 · dataflex · Zip · AddEmpty · method · since 11.0.0` ```dataflex Function ComAddEmpty Boolean isDir String pathInZip Returns Boolean ``` Adds an empty file or directory entry to the ZIP archive. - If `isDir = True`, an empty directory entry is created. - If `isDir = False`, an empty file entry is created. - `pathInZip` specifies the path stored in the ZIP archive. This method is useful when directory structure entries must exist even if no files are present. Returns True for success, False for failure. ### Zip.AddEncoded `Chilkat 11.7.0 · dataflex · Zip · AddEncoded · method · since 11.0.0` ```dataflex Function ComAddEncoded String pathInZip String encoding String data Returns Boolean ``` Adds encoded binary data as a ZIP entry. - `encoding` specifies how `data` is encoded. - Common encodings include `base64` and `hex`. - The decoded binary bytes become the contents of the ZIP entry. This method is useful when binary data already exists in textual encoded form. Returns True for success, False for failure. ### Zip.AddFile `Chilkat 11.7.0 · dataflex · Zip · AddFile · method · since 11.0.0` ```dataflex Function ComAddFile String localPath Boolean saveExtraPath Returns Boolean ``` Adds a file or directory from the local filesystem to the ZIP archive. - If `localPath` is an absolute path and `saveExtraPath = True`, the stored ZIP path includes the relative directory structure. - If `saveExtraPath = False`, only the filename is stored. - If `localPath` is already relative, the relative path is stored as-is regardless of `saveExtraPath`. This method adds a reference to the file or directory in the local filesystem. The file data is not immediately read or compressed. The actual file contents are consumed only when a `Write*` method is called, such as: - `WriteZip` - `WriteZipAndClose` - `WriteBd` - `WriteToMemory` This allows files and data entries to be accumulated in the in-memory ZIP object prior to writing the final ZIP archive. Returns True for success, False for failure. ### Zip.AddNoCompressExtension `Chilkat 11.7.0 · dataflex · Zip · AddNoCompressExtension · method` ```dataflex Procedure ComAddNoCompressExtension String fileExtension ``` Adds a file extension to the internal "no-compression" list. Files having these extensions are stored without compression because they are already compressed or because compression would provide little benefit. For example: - `.zip` - `.jpg` - `.png` - `.gz` The extension may be specified with or without the leading dot. Additional extensions remain active for the lifetime of the Zip object unless removed with `RemoveNoCompressExtension`. ### Zip.AddSb `Chilkat 11.7.0 · dataflex · Zip · AddSb · method · since 11.0.0` ```dataflex Function ComAddSb String pathInZip cComChilkatStringBuilder sb String charset Returns Boolean ``` Adds the contents of a `StringBuilder` object as a text entry in the ZIP archive. - The text is converted to bytes using the specified `charset`. - `pathInZip` specifies the filename stored in the ZIP. Returns True for success, False for failure. ### Zip.AddString `Chilkat 11.7.0 · dataflex · Zip · AddString · method · since 11.0.0` ```dataflex Function ComAddString String pathInZip String content String charset Returns Boolean ``` Adds a string as a text file entry in the ZIP archive. - The string is converted to bytes using the specified `charset`. - `pathInZip` specifies the path stored within the ZIP archive. This method is useful for dynamically generating text files directly in memory. Returns True for success, False for failure. ### Zip.AppendFiles `Chilkat 11.7.0 · dataflex · Zip · AppendFiles · method` ```dataflex Function ComAppendFiles String filePattern Boolean recurse Returns Boolean ``` Adds one or more files matching a wildcard pattern. - The wildcard character `*` matches zero or more characters. - If `recurse = True`, subdirectories are processed recursively. - If `recurse = False`, only the current directory is searched. For example: > `AppendFiles("c:/temp/*.txt", False)` This method only updates the in-memory ZIP object. The ZIP file itself is not written until a `Write*` method is called. Returns True for success, False for failure. Async variant: `AppendFilesAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.AppendFilesEx `Chilkat 11.7.0 · dataflex · Zip · AppendFilesEx · method` ```dataflex Function ComAppendFilesEx String filePattern Boolean recurse Boolean saveExtraPath Boolean archiveOnly Boolean includeHidden Boolean includeSystem Returns Boolean ``` Advanced version of `AppendFiles` with additional filtering and path options. - `saveExtraPath` controls whether the extra leading path information from the `filePattern` is preserved in the ZIP. - `archiveOnly` applies only on Windows and limits processing to files having the archive attribute set. - `includeHidden` controls whether hidden files are included. - `includeSystem` controls whether files with the System attribute are included. This method adds references to files in the in-memory ZIP object. No ZIP file is written until a `Write*` method is called. Returns True for success, False for failure. Async variant: `AppendFilesExAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.AppendZip `Chilkat 11.7.0 · dataflex · Zip · AppendZip · method` ```dataflex Function ComAppendZip String zipPath Returns Boolean ``` **Note:** This method is currently not working and will be fixed in v11.5.0 Adds all entries from another existing ZIP archive into the current ZIP object. The `zipPath` argument specifies the path of a ZIP file located in the local filesystem. All entries from the specified ZIP archive are appended to the current in-memory ZIP object. The ZIP archive itself is not rewritten until a `Write*` method is called. This method is useful for merging the contents of multiple ZIP archives into a single ZIP. Returns True for success, False for failure. ### Zip.CloseZip `Chilkat 11.7.0 · dataflex · Zip · CloseZip · method` ```dataflex Procedure ComCloseZip ``` Closes the currently open ZIP archive and clears all entries from the Zip object. This method has the same effect as calling `NewZip` without specifying a filename. ### Zip.DeleteEntry `Chilkat 11.7.0 · dataflex · Zip · DeleteEntry · method` ```dataflex Function ComDeleteEntry cComChilkatZipEntry entry Returns Boolean ``` Removes a ZIP entry from the current ZIP object. The ZIP file itself is not rewritten until a `Write*` method is called. Returns True for success, False for failure. ### Zip.EntryAt `Chilkat 11.7.0 · dataflex · Zip · EntryAt · method · since 11.0.0` ```dataflex Function ComEntryAt Integer index cComChilkatZipEntry entry Returns Boolean ``` Retrieves the ZIP entry at the specified zero-based index. - The first entry is at index `0`. - The matching entry is returned in the supplied `ZipEntry` object. Returns True for success, False for failure. ### Zip.EntryById `Chilkat 11.7.0 · dataflex · Zip · EntryById · method · since 11.0.0` ```dataflex Function ComEntryById Integer id cComChilkatZipEntry entry Returns Boolean ``` Finds a ZIP entry by its unique EntryID. The matching entry is returned in the supplied `ZipEntry` object. Returns True for success, False for failure. ### Zip.EntryMatching `Chilkat 11.7.0 · dataflex · Zip · EntryMatching · method · since 11.0.0` ```dataflex Function ComEntryMatching String pattern cComChilkatZipEntry entry Returns Boolean ``` Finds the first ZIP entry whose stored path matches a wildcard pattern. - The wildcard character `*` matches zero or more characters. - The comparison is performed against the full stored ZIP path. Returns True for success, False for failure. ### Zip.EntryOf `Chilkat 11.7.0 · dataflex · Zip · EntryOf · method · since 11.0.0` ```dataflex Function ComEntryOf String pathInZip cComChilkatZipEntry entry Returns Boolean ``` Finds a ZIP entry whose stored path exactly matches `pathInZip`. The matching entry is returned in the supplied `ZipEntry` object. Returns True for success, False for failure. ### Zip.ExcludeDir `Chilkat 11.7.0 · dataflex · Zip · ExcludeDir · method` ```dataflex Procedure ComExcludeDir String dirName ``` Adds a directory name to the exclusion list used by recursive append operations. - All directories having the specified name are skipped. - The comparison is case-insensitive. - Call multiple times to exclude multiple directory names. This affects methods such as `AppendFiles` and `AppendFilesEx`. ### Zip.ExtractExe `Chilkat 11.7.0 · dataflex · Zip · ExtractExe · method · since 9.5.0.44` ```dataflex Function ComExtractExe String exePath String dirPath Returns Boolean ``` Extracts files from a Chilkat-created self-extracting EXE. - Files are extracted into `dirPath`. - Subdirectories are automatically created as needed. - If the EXE is encrypted, `DecryptPassword` must be set before extraction. Returns True for success, False for failure. Async variant: `ExtractExeAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.GetDirectoryAsXML `Chilkat 11.7.0 · dataflex · Zip · GetDirectoryAsXML · method` ```dataflex Function ComGetDirectoryAsXML Returns String ``` Returns the ZIP directory structure as an XML document. The returned XML contains information about the entries currently contained within the ZIP archive, including files and directories. This method is useful for inspecting ZIP contents without extracting files. Returns the XML document as a string. Returns `null` on failure ### Zip.GetExeConfigParam `Chilkat 11.7.0 · dataflex · Zip · GetExeConfigParam · method` ```dataflex Function ComGetExeConfigParam String name Returns String ``` `(Windows only, for creating self-extracting EXE's)` Returns the value of a configuration parameter embedded within a self-extracting EXE. The `name` argument should be one of the XML tag names described in the `ExeXmlConfig` property documentation. For example: - `MainTitle` - `MainCaption` - `SetupExe` Returns the parameter value as a string. Returns `null` on failure ### Zip.GetMaxUncompressedSize `Chilkat 11.7.0 · dataflex · Zip · GetMaxUncompressedSize · method · since 9.5.0.96` ```dataflex Function ComGetMaxUncompressedSize Returns String ``` Returns the largest uncompressed file size contained within the ZIP archive. The size is returned as a string rather than an integer because the value may exceed the range of a 32-bit integer. This method is useful when: - Checking for extremely large files before extraction - Estimating required disk space - Detecting unusually large compressed entries Returns the size as a decimal string. Returns `null` on failure ### Zip.IsNoCompressExtension `Chilkat 11.7.0 · dataflex · Zip · IsNoCompressExtension · method` ```dataflex Function ComIsNoCompressExtension String fileExtension Returns Boolean ``` Checks whether a file extension is contained in the internal "no-compression" extension list. Files having extensions in this list are stored without compression because they are typically already compressed. The extension may be specified with or without the leading dot. For example, both of the following are valid: - `.jpg` - `jpg` Returns `True` if the extension exists in the list, otherwise returns `False`. ### Zip.IsPasswordProtected `Chilkat 11.7.0 · dataflex · Zip · IsPasswordProtected · method` ```dataflex Function ComIsPasswordProtected String zipPath Returns Boolean ``` Checks whether a ZIP archive uses legacy Zip 2.0 password protection. The `zipPath` argument specifies the path of a ZIP file in the local filesystem. This method checks only for traditional Zip 2.0 password protection. Returns `True` if the ZIP archive is password protected, otherwise returns `False`. ### Zip.LoadTaskCaller `Chilkat 11.7.0 · dataflex · Zip · LoadTaskCaller · method · since 9.5.0.80` ```dataflex Function ComLoadTaskCaller cComChilkatTask task Returns Boolean ``` Loads the caller of the task's async method. Returns True for success, False for failure. ### Zip.NewZip `Chilkat 11.7.0 · dataflex · Zip · NewZip · method` ```dataflex Function ComNewZip String zipPath Returns Boolean ``` Initializes a new empty ZIP archive. - If another ZIP archive is currently open, it is closed. - All existing in-memory ZIP entries are discarded. - The `FileName` property is set to `zipPath`. No ZIP file is actually created until a `Write*` method is called. This method resets the Zip object to a clean empty state. Returns True for success, False for failure. ### Zip.OpenBd `Chilkat 11.7.0 · dataflex · Zip · OpenBd · method · since 9.5.0.66` ```dataflex Function ComOpenBd cComChilkatBinData binData Returns Boolean ``` Opens a ZIP archive contained entirely within a `BinData` object. This method allows ZIP archives to be processed entirely in memory without requiring a filesystem file. When a ZIP archive is opened: - `PasswordProtect` is automatically set if legacy Zip 2.0 encryption is detected. - `Encryption` is automatically set if strong encryption is detected. - A value of `4` for `Encryption` indicates WinZip-compatible AES encryption. Returns True for success, False for failure. ### Zip.OpenEmbedded `Chilkat 11.7.0 · dataflex · Zip · OpenEmbedded · method` ```dataflex Function ComOpenEmbedded String exeFilename String resourceName Returns Boolean ``` `(Windows only)` Opens a ZIP archive embedded as a resource within a Windows executable. - `exeFilename` specifies the EXE file path. - `resourceName` specifies the embedded resource name containing the ZIP data. This method is useful when ZIP archives are packaged within Windows applications. Returns True for success, False for failure. ### Zip.OpenFromByteData `Chilkat 11.7.0 · dataflex · Zip · OpenFromByteData · method` ```dataflex Function ComOpenFromByteData Variant byteData Returns Boolean ``` Opens a ZIP archive from in-memory byte data. When the ZIP archive is opened: - `PasswordProtect` is automatically set if legacy password protection is detected. - `Encryption` is automatically set if strong encryption is detected. - `Encryption = 4` indicates AES encryption. Returns True for success, False for failure. ### Zip.OpenFromMemory `Chilkat 11.7.0 · dataflex · Zip · OpenFromMemory · method` ```dataflex Function ComOpenFromMemory Variant inData Returns Boolean ``` Opens a ZIP archive directly from in-memory binary data. This allows ZIP processing without using filesystem files. Typical use cases include: - ZIP data loaded from a database - ZIP data received from HTTP responses - ZIP data stored entirely in memory When the ZIP archive is opened: - `PasswordProtect` is automatically set if Zip 2.0 encryption is detected. - `Encryption` is automatically set if strong encryption is detected. Returns True for success, False for failure. ### Zip.OpenZip `Chilkat 11.7.0 · dataflex · Zip · OpenZip · method` ```dataflex Function ComOpenZip String zipPath Returns Boolean ``` Opens a ZIP archive from the local filesystem. The `zipPath` argument specifies the path of the ZIP file to open. Encrypted ZIP archives may be opened without providing a password, but encrypted entries cannot be extracted until the correct password is provided using `DecryptPassword`. When the ZIP archive is opened: - `PasswordProtect` is automatically set if legacy Zip 2.0 encryption is detected. - `Encryption` is automatically set if strong encryption is detected. - `Encryption = 4` indicates WinZip-compatible AES encryption. Returns True for success, False for failure. Async variant: `OpenZipAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.QuickAppend `Chilkat 11.7.0 · dataflex · Zip · QuickAppend · method` ```dataflex Function ComQuickAppend String zipPath Returns Boolean ``` Efficiently appends additional entries to an existing ZIP archive. The `zipPath` argument specifies the path of an existing ZIP archive in the local filesystem. This method avoids rewriting existing entries. - Existing ZIP entries remain unchanged. - New entries are appended to the end of the ZIP archive. - The ZIP central directory is updated accordingly. This method is typically faster than rebuilding the entire ZIP archive. Returns True for success, False for failure. Async variant: `QuickAppendAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.RemoveNoCompressExtension `Chilkat 11.7.0 · dataflex · Zip · RemoveNoCompressExtension · method` ```dataflex Procedure ComRemoveNoCompressExtension String fileExtension ``` Removes a file extension from the internal "no-compression" extension list. After removal, files having this extension may be compressed normally. The extension may be specified with or without the leading dot. ### Zip.SetCompressionLevel `Chilkat 11.7.0 · dataflex · Zip · SetCompressionLevel · method` ```dataflex Procedure ComSetCompressionLevel Integer level ``` Sets the compression level for all file and data entries currently contained within the ZIP object. - `0` → No compression - `9` → Maximum compression The default compression level is `6`. **Important:** This method should be called after files or data entries have already been added to the ZIP object. The compression level cannot be changed for mapped entries originating from an already-open ZIP archive. ### Zip.SetExclusions `Chilkat 11.7.0 · dataflex · Zip · SetExclusions · method` ```dataflex Procedure ComSetExclusions cComCkStringArray excludePatterns ``` Specifies a collection of wildcard exclusion patterns used when adding files to the ZIP archive. Each pattern may use the wildcard character `*` to match zero or more characters. Files matching any exclusion pattern are skipped. ### Zip.SetExeConfigParam `Chilkat 11.7.0 · dataflex · Zip · SetExeConfigParam · method` ```dataflex Procedure ComSetExeConfigParam String paramName String paramValue ``` `(Windows only, for creating self-extracting EXE's)` Sets a configuration parameter embedded within a self-extracting EXE created by `WriteExe` or `WriteExe2`. The `paramName` should be one of the XML configuration tag names described in the `ExeXmlConfig` property documentation. For example: > `SetExeConfigParam("MainUnzipBtn","Extract")` This changes the text displayed on the self-extractor's main unzip button. ### Zip.Unzip `Chilkat 11.7.0 · dataflex · Zip · Unzip · method` ```dataflex Function ComUnzip String dirPath Returns Integer ``` Extracts all files and directories from the ZIP archive. - `dirPath` specifies the destination directory. - Subdirectories are automatically created as needed. Returns the number of files extracted. Returns `-1` if a failure occurs. Async variant: `UnzipAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.UnzipInto `Chilkat 11.7.0 · dataflex · Zip · UnzipInto · method` ```dataflex Function ComUnzipInto String dirPath Returns Integer ``` Extracts all files into a single directory. All directory path information stored within the ZIP archive is ignored. If multiple files have the same filename, later extracted files overwrite earlier ones. Returns the number of files extracted, or `-1` on failure. Async variant: `UnzipIntoAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.UnzipMatching `Chilkat 11.7.0 · dataflex · Zip · UnzipMatching · method` ```dataflex Function ComUnzipMatching String dirPath String pattern Boolean verbose Returns Integer ``` Extracts only entries whose stored paths match a wildcard pattern. - The wildcard character `*` matches zero or more characters. - If no wildcard is used, an exact filename match is required. Subdirectories are automatically created as needed. Returns the number of files extracted, or `-1` on failure. Async variant: `UnzipMatchingAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.UnzipMatchingInto `Chilkat 11.7.0 · dataflex · Zip · UnzipMatchingInto · method` ```dataflex Function ComUnzipMatchingInto String dirPath String pattern Boolean verbose Returns Integer ``` Extracts matching entries into a single directory while ignoring all stored ZIP path information. Matching behavior is identical to `UnzipMatching`. If duplicate filenames occur, later extracted files overwrite earlier ones. Returns the number of files extracted, or `-1` on failure. Async variant: `UnzipMatchingIntoAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.UnzipNewer `Chilkat 11.7.0 · dataflex · Zip · UnzipNewer · method` ```dataflex Function ComUnzipNewer String dirPath Returns Integer ``` Extracts only files that: - Do not already exist - Or have older modification timestamps than the ZIP entry Subdirectories are automatically created as needed. Returns the number of files extracted, or `-1` on failure. Async variant: `UnzipNewerAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.VerifyPassword `Chilkat 11.7.0 · dataflex · Zip · VerifyPassword · method` ```dataflex Function ComVerifyPassword Returns Boolean ``` Verifies that the current `DecryptPassword` value is correct for the currently opened ZIP archive. This method allows password validation before attempting extraction. Returns `True` if the password is valid, otherwise returns `False`. ### Zip.WriteBd `Chilkat 11.7.0 · dataflex · Zip · WriteBd · method · since 9.5.0.66` ```dataflex Function ComWriteBd cComChilkatBinData binData Returns Boolean ``` Writes the ZIP archive to a `BinData` object instead of a filesystem file. The generated ZIP archive exists entirely in memory. The ZIP data written by this method may later be opened using `OpenBd`. Returns True for success, False for failure. Async variant: `WriteBdAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.WriteExe `Chilkat 11.7.0 · dataflex · Zip · WriteExe · method` ```dataflex Function ComWriteExe String exeFilename Returns Boolean ``` `(Windows only, for creating self-extracting EXE's)` Creates a Windows self-extracting executable (EXE). The generated EXE contains both the extraction logic and the ZIP archive data. There are no limitations on: - Total ZIP size - Individual file size - Number of files The generated EXE supports the following command-line arguments: - `-log logFileName` - `-unzipDir unzipDirectoryPath` - `-pwd password` - `-ap autoRunParams` Returns True for success, False for failure. Async variant: `WriteExeAsync` — same arguments, returns a `Task` (see Async variants below). See also: - [More information about self-extracting executables.](http://www.cknotes.com/?p=351) ### Zip.WriteExeToMemory `Chilkat 11.7.0 · dataflex · Zip · WriteExeToMemory · method` ```dataflex Function ComWriteExeToMemory Returns Variant ``` (Relevant only when running on a Microsoft Windows operating system.) Same as WriteExe, but instead of writing a file, the MS-Windows EXE is written to memory. Returns `null` on failure Async variant: `WriteExeToMemoryAsync` — same arguments, returns a `Task` (see Async variants below). See also: - [More information about self-extracting executables.](http://www.cknotes.com/?p=351) ### Zip.WriteToMemory `Chilkat 11.7.0 · dataflex · Zip · WriteToMemory · method` ```dataflex Function ComWriteToMemory Returns Variant ``` Same as WriteZip, but instead of writing the Zip to a file, it writes to memory. Zips that are written to memory can also be opened from memory by calling OpenFromMemory. Returns `null` on failure Async variant: `WriteToMemoryAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.WriteZip `Chilkat 11.7.0 · dataflex · Zip · WriteZip · method` ```dataflex Function ComWriteZip Returns Boolean ``` Saves the Zip to a file and implictly re-opens it so further operations can continue. Use WriteZipAndClose to write and close the Zip. There is no limitation on the size of files that may be contained within a .zip, the total number of files in a .zip, or the total size of a .zip. If necessary, WriteZip will use the ZIP64 file format extensions when 4GB or file count limitations of the old zip file format are exceeded. Returns True for success, False for failure. Async variant: `WriteZipAsync` — same arguments, returns a `Task` (see Async variants below). ### Zip.WriteZipAndClose `Chilkat 11.7.0 · dataflex · Zip · WriteZipAndClose · method` ```dataflex Function ComWriteZipAndClose Returns Boolean ``` Saves the Zip to a file and closes it. On return, the Zip object will be in the state as if NewZip had been called. There is no limitation on the size of files that may be contained within a .zip, the total number of files in a .zip, or the total size of a .zip. If necessary, WriteZip will use the ZIP64 file format extensions when 4GB or file count limitations of the old zip file format are exceeded. Returns True for success, False for failure. Async variant: `WriteZipAndCloseAsync` — same arguments, returns a `Task` (see Async variants below). ## Events and callbacks This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`). ## Async variants Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on. ```dataflex Function ComAppendFilesAsync String filePattern Boolean recurse Returns cComChilkatTask Function ComAppendFilesExAsync String filePattern Boolean recurse Boolean saveExtraPath Boolean archiveOnly Boolean includeHidden Boolean includeSystem Returns cComChilkatTask Function ComExtractExeAsync String exePath String dirPath Returns cComChilkatTask Function ComOpenZipAsync String zipPath Returns cComChilkatTask Function ComQuickAppendAsync String zipPath Returns cComChilkatTask Function ComUnzipAsync String dirPath Returns cComChilkatTask Function ComUnzipIntoAsync String dirPath Returns cComChilkatTask Function ComUnzipMatchingAsync String dirPath String pattern Boolean verbose Returns cComChilkatTask Function ComUnzipMatchingIntoAsync String dirPath String pattern Boolean verbose Returns cComChilkatTask Function ComUnzipNewerAsync String dirPath Returns cComChilkatTask Function ComWriteBdAsync cComChilkatBinData binData Returns cComChilkatTask Function ComWriteExeAsync String exeFilename Returns cComChilkatTask Function ComWriteExeToMemoryAsync Returns cComChilkatTask Function ComWriteToMemoryAsync Returns cComChilkatTask Function ComWriteZipAsync Returns cComChilkatTask Function ComWriteZipAndCloseAsync Returns cComChilkatTask ``` ## Deprecated members — do not use in new code | Member | Kind | Deprecated in | Use instead | |---|---|---|---| | `AppendBd` | method | before 11.6.1 | `AddBd` | | `AppendData` | method | before 11.6.1 | `AddData` | | `AppendDataEncoded` | method | before 11.6.1 | `AddEncoded` | | `AppendNew` | method | before 11.6.1 | `AddEmpty` | | `AppendNewDir` | method | before 11.6.1 | `AddEmpty` | | `AppendOneFileOrDir` | method | before 11.6.1 | `AddFile` | | `AppendSb` | method | before 11.6.1 | `AddSb` | | `AppendString` | method | before 11.6.1 | `AddString` | | `AppendString2` | method | before 11.6.1 | `AddString` | | `FirstEntry` | method | before 11.6.1 | `EntryAt` | | `FirstMatchingEntry` | method | before 11.6.1 | `EntryMatching` | | `GetEntryByID` | method | before 11.6.1 | `EntryById` | | `GetEntryByIndex` | method | before 11.6.1 | `EntryAt` | | `GetEntryByName` | method | before 11.6.1 | `EntryOf` | | `GetExclusions` | method | before 11.6.1 | — | | `SetPassword` | method | before 11.6.1 | — | ## Related classes [`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/BinData.md), [`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/StringArray.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/Task.md), [`ZipEntry`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/ZipEntry.md)