zipMerge (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Actions that can be performed on a multi-part archive

The multi-part archive is found on diskettes

See also

zipMerge (Function)

In french: zipRegroupe

Merges the different sub-archives found in a multi-part archive to create a single-part archive.

Versions 18 and later

This function now supports the 7z format.

New in version 18

This function now supports the 7z format.

Example

See additional examples

// Open a multi-part archive
ResOpenArchive = zipOpen("MyArchive", "C:\MyArchives\Archive.zip")
IF ResOpenArchive = 0 THEN
...
// Merge the sub-archives found in a multi-part archive
ResMerge = zipMerge("MyArchive",...
"C:\MyArchives\SingleArchive.WDZ")
...
END

MyArchive is zipArchive
// Open a multi-part archive
ResOpenArchive = zipOpen(MyArchive, "C:\MyArchives\Archive.zip")
IF ResOpenArchive = 0 THEN
...
// Merge the sub-archives found in a multi-part archive
ResMerge = zipMerge(MyArchive,...
"C:\MyArchives\SingleArchive.WDZ")
...
END

Syntax

<Result> = zipMerge(<Archive> , <Archive destination> [, <Progress bar management>])

<Result>: Integer

0 if the sub-archives have been merged,
an error code (value greater than 0) otherwise. For more details on these error codes, see the Remarks.

<Archive>: Character string (with quotes) or zipArchive variable

Name of archive to use.
This name can correspond to:
an archive name, defined by zipOpen or by zipCreate.
Versions 15 and later
the name of a zipArchive variable.
New in version 15
the name of a zipArchive variable.
the name of a zipArchive variable.

<Archive destination>: Character string (with quotes)

Physical path of new single-part archive (up to 260 characters). This path must contain the name of single-part archive to create. If the extension (.WDZ or .ZIP) is not specified, the extension corresponds to the initial extension. You have the ability to specify the same path and name as the split archive: the split archive will be overwritten by the merged archive.

<Progress bar management>: Optional character string (with or without quotes)

Versions 21 and later
Name of Progress Bar control found in a window. The progress bar will display the progress of grouping.
New in version 21
Name of Progress Bar control found in a window. The progress bar will display the progress of grouping.
Name of Progress Bar control found in a window. The progress bar will display the progress of grouping.

Remarks

Use conditions

Remark: The merge operation can be performed if:

The archive exists (an archive is created by zipCreate).
The archive is a multi-part archive.
The archive is not in "CAB" format, in "RAR" format or in "TAR" or TARGZ" format.

Reminder:

Only the archives in ZIP, TAR and TGZ (TAR.GZ) format are available.

Error codes

The following error codes are returned:

1: The path passed as parameter does not exist.
2: Access denied: the user has no sufficient rights.
3: The archive is corrupted.
6: The sub-archives are not arranged in order.

The message corresponding to the error code is returned by zipMsgError.

Closing the archive

Once zipMerge has been used on an archive, this archive is not closed. You must use:

zipClose to close the multi-part archive.
zipOpen to open the new single-part archive.

Number of parts

zipNbPart enables you to find out the number of sub-archives in a multi-part archive.

Actions that can be performed on a multi-part archive

Some archiving functions can only be used with single-part archives (add and delete files, create a self-extracting executable, etc.). To perform these operations, simply group the subarchives (zipMerge) to obtain a single-part archive.

From a multi-part archive, you only have the ability to:

Merge the different parts (zipMerge).
Get information about the archive and the files in the archive (zipExtractPath, zipInfoFile, zipListFile, etc.).
Extract the files (zipExtractFile, zipExtractAll).

The multi-part archive is found on diskettes

If the different sub-archives are found on diskettes, the next diskette will be automatically requested via a dialog box when the sub-archives are merged. An error will occur if the merge operation is canceled by the user (the multi-part archive is not found).

Business / UI classification : Business Logic

Component : wd260zip.dll