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
Encrypting/Decrypting a character string
Encryption in Android/Java and decryption by a WINDEV application (or conversely)

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

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 correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its installation directory or one of its subdirectories, as well as to the external memory (SDCard).
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In iOS/iPadOS, the file system is read-only on the device and on the emulator. An application can only write to its installation directory or one of its subdirectories.

<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 correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its installation directory or one of its subdirectories, as well as to the external memory (SDCard).
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In iOS/iPadOS, the file system is read-only on the device and on the emulator. An application can only write to its installation directory or one of its subdirectories.

<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.
New in version 2025
Secret strings are not available for this parameter in Android/Android widget applications.

<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).
This constant is not available.
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 PBE algorithm (Password Based Encryption).

<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.
This parameter is ignored.

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.

Encrypting/Decrypting a character string

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

Encryption in Android/Java and decryption by a WINDEV application (or conversely)

Warning: the encryption/decryption algorithms used in Java and Android are not the same as those used by WINDEV. Therefore, you cannot encrypt a file in Java or Android and decrypt it with WINDEV and vice versa.

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