fDecrypt (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / External file functions

Error handling
Operating mode in Windows Vista (and later)
Encrypting/Decrypting a character string
Encryption in PHP

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

fDecrypt (Function)

In french: fDécrypte

Warning
From version 24, fUncrypt is kept for backward compatibility. This function has been replaced with fDecrypt.

Decrypts a file that was encrypted by fEncrypt.

Example

See additional examples

// Décryptage d'un fichier
ResDécrypte = fDecrypt("C:\MonRep\FichierCrypté.txt", "C:\MonRep\FichierDécrypté.txt", "MotDePasse")

Syntax

<Result> = fDecrypt(<Path of file to decrypt> , <Path of decrypted file> , <Password> [, <Type of encryption used> [, <Format of encrypted file>]])

<Result>: Boolean

True if decryption has been completed,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<Path of file to decrypt>: Character string

Name and full (or relative) path of the file to decrypt (up to 260 characters). A UNC path can be used. This file must have been encrypted by fEncrypt.
This parameter can be in Ansi or Unicode format.

<Path of decrypted file>: Character string

Name and full (or relative) path of the decrypted file (up to 260 characters). A UNC path can be used.
This parameter can be in Ansi or Unicode format.

<Password>: Character string or Secret string

Password used to decrypt the file. This password must be identical to the password used to encrypt the file. A long password provides better encryption security.
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.

<Type of encryption used>: Optional constant

Specifies the type of encryption used. This parameter must be identical to the one specified during the encryption.
encryptFast
(Default value) Priority was given to the encryption speed (algorithm on 128 bits).
The algorithm used will be a Blowfish algorithm with 16 rounds.
encryptNone No encryption was performed.
encryptRC516 Priority is given to the encryption security (RC5 algorithm on 16 rounds).
This constant has no effect.
encryptSecure Priority was given to the encryption security (RC5 algorithm on 128 bits).
The algorithm used will be a 128-bit RIJNDAEL algorithm.

<Format of encrypted file>: Optional Integer constant

Specifies the format of the encrypted file. This parameter must be identical to the one specified during the encryption.
encodeBASE64 BASE 64 format. The encrypted file will contain printable characters only.
encodeNone or False
(Default value) Binary format. The encrypted file may contain non-printable characters.
encodePCS or True ASCII format. The encrypted file will contain printable characters only.
encodeUUEncode UUEncode format. The encrypted file will contain printable characters only.

Remarks

Error handling

fDecrypt throws an error in the following cases:

the file to decrypt does not exist or it is locked,
the path of the file to decrypt is invalid,
the <Password> is an empty string or it differs from the <Password> used to encrypt the file,
the <Type of encryption used> differs from the <Type of encryption> specified during the encryption,
the <Format of encrypted file> differs from the one specified during the encryption,
the user has no read rights on the file to decrypt,
the user has no write rights on the file to decrypt.
a Unicode string was used for the <Path of file to decrypt> or for the <Path of decrypted file> in an operating system such as Windows 98 or Windows Me.

Operating mode in Windows Vista (and later)

If this function does not work 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).

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

Programming tip: If you need to manipulate / modify files or directories, without needing administrator privileges, it is advisable:

avoid writing to the Windows directory or to the "Program Files" directory,
use the system directory of the application (returned by SysDir with the srAppDataCommun constant, for example).

Remark: Under Windows Vista (and higher), the virtualization mechanism makes applications "Vista-compatible".. 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.

Encrypting/Decrypting a character string

To encrypt/decrypt a character string, use Encrypt and Decrypt.

Encryption in PHP

In PHP, the BlowFish encryption (encryptFast constant) and the RINJDAEL encryption (encryptSecure constant) are based on the MCrypt library. This library is commonly used by the PHP hosting providers and therefore it is always enabled. This library can be downloaded from the PHP site.

To enable (if necessary) this library locally, the following elements are required:

PHP installed.
the PHP.INI file found in the Windows directory must include the "extension=php_mcrypt.dll" line.
the php_mcrypt.dll file must exist in the directory of PHP extensions. This directory is defined in the PHP.INI file by the "extension_dir" variable.

Related Examples:

Unit examples (WEBDEV): The encryption functions

[ + ] This example explains how to use the encryption/decryption functions of WEBDEV. This example allows you to:
- Encrypt a character string
- Decrypt a character string

Unit examples (WINDEV): The encryption functions

[ + ] Using the encryption/decryption functions of WINDEV.
This example is used to:
- Encrypt a character string
- Decrypt a character string

Unit examples (WINDEV Mobile): The encryption functions

[ + ] Using the WLanguage encryption and decryption functions.
This example is used to:
- Encrypt a character string
- Decrypt a character string

Component: wd300std.dll