# CreateArchive Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: {% tabs %} {% tab title="Parameter: SourceProperties" %} | Name | Description | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | SourceType : `SourceFilesType` |

Source files input type.

Possible values:

Source files input type.

Source files input type.


Default: 0
Example: PathAndFileMask

| | Directory : `String` |

Source directory.


Default: -
Example: C:\example\folder\

| | FileMask : `String` |

The search string to match against the names of files.

This parameter can contain a combination of valid literal path and wildcard (\* and ?) characters (see Remarks), but doesn't support regular expressions.

The default pattern is "", which returns all files.


Default:
Example: \*

| | IncludeSubFolders : `Boolean` |

Indicates if subfolders and files should also be zipped.


Default: False
Example: false

| | FlattenFolders : `Boolean` |

Choose if source folder structure should be flatten when zipped.


Default: False
Example: false

| | FilePathsList : `List` |

List of full file paths to include in zip.


Default: -
Example: new List { Directory.GetFiles(\_dir, "\*.txt")\[0] };

| | RemoveZippedFiles : `Boolean` |

If true, files added to the zip are removed from source directory.


Default: False
Example: false

| | {% endtab %} | | {% tab title="Parameter: DestinationProperties" %} | Name | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Directory : `String` |

Destination directory.


Default: -
Example: c:\temp

| | FileName : `String` |

Filename of the zip to create.


Default: -
Example: sample.zip

| | 🗝Password : `String` |

Add password protection to zip.


Default: -
Example: foobar123

| | RenameDuplicateFiles : `Boolean` |

True: If source files contains duplicate names, they are renamed (example.txt --> example\_(1).txt).

False: Throws error if duplicate file names are found.


Default: True
Example: true

| | {% endtab %} | | {% tab title="Parameter: Options" %} | Name | Description | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | UseZip64 : `UseZip64Option` |

Always: Always use ZIP64 extensions when writing zip archives, even when unnecessary.

AsNecessary: Use ZIP64 extensions when writing zip archives, as necessary (when single entry or entries in total exceeds 0xFFFFFFFF in size, or when there are more than 65535 entries).

Never: Do not use ZIP64 extensions when writing zip archives.

Possible values:

Always: Always use ZIP64 extensions when writing zip archives, even when unnecessary.

AsNecessary: Use ZIP64 extensions when writing zip archives, as necessary (when single entry or entries in total exceeds 0xFFFFFFFF in size, or when there are more than 65535 entries).

Never: Do not use ZIP64 extensions when writing zip archives.

Always: Always use ZIP64 extensions when writing zip archives, even when unnecessary.

AsNecessary: Use ZIP64 extensions when writing zip archives, as necessary (when single entry or entries in total exceeds 0xFFFFFFFF in size, or when there are more than 65535 entries).

Never: Do not use ZIP64 extensions when writing zip archives.

Always: Always use ZIP64 extensions when writing zip archives, even when unnecessary.

AsNecessary: Use ZIP64 extensions when writing zip archives, as necessary (when single entry or entries in total exceeds 0xFFFFFFFF in size, or when there are more than 65535 entries).

Never: Do not use ZIP64 extensions when writing zip archives.


Default: 1
Example: AsNecessary

| | Encoding : `FileEncoding` |

Encoding for file and directory names.

Possible values:

Encoding for file and directory names.

Encoding for file and directory names.

Encoding for file and directory names.

Encoding for file and directory names.

Encoding for file and directory names.


Default: -
Example: Encoding.UTF8

| | EnableBom : `Boolean` |

Additional option for UTF-8 encoding to enable bom.


Default: -
Example: true

| | EncodingInString : `String` |

File encoding to be used. A partial list of possible encodings: .


Default: -
Example: utf-8

| | ThrowErrorIfNoFilesFound : `Boolean` |

Throw error if no source files are found. Otherwise returns object with FileCount: 0.


Default: True
Example: true

| | DestinationFileExistsAction : `FileExistAction` |

Choose action if destination zip file already exists.

Error: throws error.

Overwrite: Overwrites existing zip file with new one.

Rename: Renames new zip file (example.zip --> example\_(1).zip).

Append: Adds new files to zip, if file already exists in zip, it is renamed.

Possible values:

Choose action if destination zip file already exists.

Error: throws error.

Overwrite: Overwrites existing zip file with new one.

Rename: Renames new zip file (example.zip --> example\_(1).zip).

Append: Adds new files to zip, if file already exists in zip, it is renamed.

Choose action if destination zip file already exists.

Error: throws error.

Overwrite: Overwrites existing zip file with new one.

Rename: Renames new zip file (example.zip --> example\_(1).zip).

Append: Adds new files to zip, if file already exists in zip, it is renamed.

Choose action if destination zip file already exists.

Error: throws error.

Overwrite: Overwrites existing zip file with new one.

Rename: Renames new zip file (example.zip --> example\_(1).zip).

Append: Adds new files to zip, if file already exists in zip, it is renamed.

Choose action if destination zip file already exists.

Error: throws error.

Overwrite: Overwrites existing zip file with new one.

Rename: Renames new zip file (example.zip --> example\_(1).zip).

Append: Adds new files to zip, if file already exists in zip, it is renamed.


Default: 0
Example: Error

| | CreateDestinationFolder : `Boolean` |

Create destination folder if it does not exist.


Default: False
Example: false

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | ------------------------------ | --------------------------------------------------------------------------------- | | Path : `String` |

Full path to zip created.
Example: c:\temp\zip\_sample.zip

| | FileCount : `Int32` |

Number of files in created zip file.
Example: 1

| | ArchivedFiles : `List` |

List of files zipped.
Example: TestFile.txt, TestFile2.txt

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[1.3.0] - 2025-12-29 #### Fixed * Fix repository url in metadata ### \[1.2.0] - 2024-12-13 #### Changed * Drop DotNetZip in favour of ProDotNetZip because of security reasons * DotNetZip has a HIGH severity directory traversal vulnerability (CVE reported Nov 2024) affecting versions 1.10.1 through 1.16.0 with no patch available (package is deprecated) * The migration to ProDotNetZip 1.20.0 addresses this security concern ### \[1.1.0] - 2023-11-27 #### Added * \[Breaking] Added Encoding for file and directory names. ### \[1.0.0] - 2022-02-23 #### Added * Initial implementation {% endtab %} {% endtabs %}