Delphi DLL

Exclude Multiple Directories When Adding Files to a ZIP

See more Zip Examples

This example demonstrates how to use the ExcludeDir method to exclude specific directory names when recursively adding files to a ZIP archive.

The ExcludeDir method excludes directories by name. Any directory matching an excluded name is skipped entirely, including all files and subdirectories beneath it.

This is useful for excluding directories such as:

• .git
• node_modules
• bin
• obj
• Temporary or cache directories

Call ExcludeDir once for each directory name to exclude.

Suppose the local filesystem contains:

c:/project/src/main.cpp
c:/project/src/util.cpp
c:/project/bin/app.exe
c:/project/obj/main.obj
c:/project/.git/config
c:/project/node_modules/library/index.js

After excluding bin, obj, .git, and node_modules, only the files beneath src are added to the ZIP archive.

The resulting ZIP archive contains:

project/src/main.cpp
project/src/util.cpp

Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Zip;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
zip: HCkZip;
recurse: Boolean;
saveExtraPath: Boolean;
archiveOnly: Boolean;
includeHidden: Boolean;
includeSystem: Boolean;

begin
success := False;

success := False;

zip := CkZip_Create();

success := CkZip_NewZip(zip,'project.zip');
if (success = False) then
  begin
    Memo1.Lines.Add(CkZip__lastErrorText(zip));
    Exit;
  end;

// Exclude several directory names.
// 
// Any directory matching one of these names will be skipped
// during recursive file appending.
CkZip_ExcludeDir(zip,'bin');
CkZip_ExcludeDir(zip,'obj');
CkZip_ExcludeDir(zip,'.git');
CkZip_ExcludeDir(zip,'node_modules');

// Recursively append all files beneath c:/project.
// 
// Because saveExtraPath = True, the ZIP paths will
// include "project/" as the leading directory.
recurse := True;
saveExtraPath := True;
archiveOnly := False;
includeHidden := True;
includeSystem := False;

success := CkZip_AppendFilesEx(zip,'c:/project',recurse,saveExtraPath,archiveOnly,includeHidden,includeSystem);
if (success = False) then
  begin
    Memo1.Lines.Add(CkZip__lastErrorText(zip));
    Exit;
  end;

// Write the ZIP archive.
success := CkZip_WriteZipAndClose(zip);
if (success = False) then
  begin
    Memo1.Lines.Add(CkZip__lastErrorText(zip));
    Exit;
  end;

Memo1.Lines.Add('ZIP archive created successfully.');

CkZip_Dispose(zip);

end;