Skip to main content

The "xzip_count_dir" Function

Syntax#

xzip_count_dir(arch, dir);
ArgumentTypeDescription
archstringThe full path and filename of the archive to check
dirstringThe relative directory within the archive to count

Description#

Returns the number of files contained within an individual directory within the given archive created with xzip_create. An empty directory will return 0, or -1 if the archive doesn't exist at all.

Unlike file names and other directories, dir here should be written as a relative path. (i.e. If the directory is a subfolder, all parent folders must be included in the argument.)

As archives have no mount point, you should not supply a drive letter or leading slash when specifying a directory to list. Use "" to list files in the root directory of the archive.

important

Due to GameMaker's string handling, slashes in paths should be escaped (i.e. \\, not \). Do not add a final slash to directories!

tip

By default, only the contents of the exact folder specified will be listed. To include the contents of any subfolders as well, see xzip_recurse.

Example#

my_zip = xzip_create("C:\\archive.xz", "C:\\file1.txt", "C:\\file2.pdf");
if (xzip_count_dir(my_zip, "my\\destination\\folder") == 0) {
xzip_move(my_zip, "my\\destination\\folder", "file1.txt", "file2.pdf");
}