The "xzip_list" Function

Syntax

xzip_list(arch, [relative]);
ArgumentTypeDescription
archstringThe full path and filename of the archive to check
[relative]booleanOptional: Enables or disables including relative paths in the results (disabled by default)

Description

Returns an array of strings containing the file names and extensions (and optionally, relative paths) contained within the given archive. The array index for each file also corresponds to the archive index and can be used when extracting files in place of a file name itself.

Many functions support inputting an array of files, in which case an array returned by this function can be passed in directly.

Example

file_array = xzip_list("C:\\archive.xz");
xzip_extract("C:\\archive.xz", "C:\\extracted", file_array[0]);

This will retrieve a list of files contained in an archive and extract the first file in the list. Remember that because the array index corresponds to the archive index, we could also use just 0 here instead of file_array[0].