fUncompress (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Functions for managing external files

Files compressed with the earlier WINDEV versions

Operating mode in Windows Vista (and later)

ProgressBar

See also

Constants for the external files

Functions for managing external files

Handling the external files

Storing files in Android

Summary table: Managing the application directories according to the platform

fDetectRemovableStorage

fReadLineRegularExpression

fRemoveDir

fRename

fReportsAndQueriesDir

Error codes
Files compressed with the earlier WINDEV versions
Operating mode in Windows Vista (and later)
ProgressBar

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

fUncompress (Function)

In french: fDécompacte

Decompresses a file that was compressed by fCompress.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

See additional examples

// Decompress a file
ResDecompress = fUncompress("C:\MyDirectories\CompressedFile.txt", ...
"C:\MyDirectories\DecompressedFile.txt")

Syntax

<Result> = fUncompress(<Path of file to decompress> [, <Path of decompressed file>])

<Result>: Integer

0 if the decompression was performed,
an error code (value greater than 0) otherwise. The message corresponding to the error code is returned by ErrorInfo associated with the errMessage constant.

<Path of file to decompress>: Character string (with quotes)

Name and full (or relative) path of file to decompress (up to 260 characters). A UNC path can be used. This file must have been compressed by fCompress.

<Path of decompressed file>: Optional character string (with quotes)

The following cases are supported:
To decompressed a file under a given name and in a given directory:
Name and full (or relative) path of the decompressed file (up to 260 characters). A UNC path can be used.
To decompressed a file under a its initial name (before compression) and in a given directory:
Directory (string ending with "\" or ":") of the decompressed file (up to 260 characters). A UNC path can be used.
If this parameter is not specified:
The file is decompressed under its name and in its source directory (before compression). Caution: The source directory must exist.

Remarks

Error codes

The following error codes are returned:

1: The file to decompress cannot be opened.
2: Unable to create the decompressed file. This error occurs:
- if <Path of file to decompress> and <Path of decompressed file> are identical,
- if the directory of <Path of decompressed File> does not exist.
3: The file to decompress was not compressed by fCompress.
4: The file cannot be decompressed: the file is copied.
6: The decompress operation was canceled by the user: fStopCompress was not run.
7: Insufficient space to create the decompressed file.

The message corresponding to the error code is returned by ErrorInfo associated with the errMessage constant.

Files compressed with the earlier WINDEV versions

fUncompress can be used to decompress files compressed with the earlier versions of WINDEV and WEBDEV.

Operating mode in Windows Vista (and later)

If this function does not operate properly in Windows Vista (and later), check whether the file or directory used is not in one of the system directories (Windows directory or "Program Files" directory).

Indeed, in Windows Vista (and later), with the UAC mechanism (User Account Control) enabled, you must have the administrator privileges to handle and/or modify the files or directories in the system directories (Windows directory or "Program Files" directory).

Programming tip: To handle and/or modify the files or directories without administrator privileges, you should:

avoid writing into the Windows directory or into the "Program Files" directory,
use the system directory corresponding to the application (returned by SysDir associated with the srCommonAppData constant).

Remark: In Windows Vista (and later), the virtualization mechanism is used to make the applications compatible with Vista. If the file is created in a system directory without having sufficient rights, this file will actually be created in another directory (C:\Users\<LOGIN>AppData\Local\VirtualStore\Windows\). In this case, the file cannot be shared between several applications.

ProgressBar

In Windows, to view the progress of file decompression, an event must be branched on CompressProgressBar (1174). When this message is received, the _EVE.wParam variable contains the percentage of file decompression.

Component : wd240std.dll