PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Notes
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Calculates the Hash of a file according to a specific algorithm. You can calculate:
  • a simple hash.
  • a hash with message authentication.
  • Versions 27 and later
    a hash obtained with a key derivation function that takes a salt as parameter (PBKDF2).
    AndroidAndroid Widget Not available.
    New in version 27
    a hash obtained with a key derivation function that takes a salt as parameter (PBKDF2).
    AndroidAndroid Widget Not available.
    a hash obtained with a key derivation function that takes a salt as parameter (PBKDF2).
    AndroidAndroid Widget Not available.
Reminder: Hashing is used to summarize a file or a character string. This summary is called Hash.
Versions 15 and later
Android This function is now available for Android applications.
New in version 15
Android This function is now available for Android applications.
Android This function is now available for Android applications.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for iPhone/iPad applications.
Versions 18 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android widget mode.
New in version 18
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android widget mode.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Syntax

Calculating a simple hash Hide the details

<Result> = HashFile(<Type of algorithm> , <File path> [, <Progress Bar>])
<Result>: Buffer
Result of <File path> hashing with the <Type of algorithm> algorithm.
Caution: This result may contain non-displayable characters.
<Type of algorithm>: Integer constant
Indicates the type of algorithm used when hashing the <File path> file:
Versions 25 and later
MD4 family
New in version 25
MD4 family
MD4 family
Versions 25 and later
HA_MD4

AndroidAndroid Widget Not available.
New in version 25
HA_MD4

AndroidAndroid Widget Not available.
HA_MD4

AndroidAndroid Widget Not available.
Versions 26 and later
AndroidAndroid Widget This constant is now available.
New in version 26
AndroidAndroid Widget This constant is now available.
AndroidAndroid Widget This constant is now available.
MD5 familyHA_MD5_128
Versions 24 and later
MURMUR family
New in version 24
MURMUR family
MURMUR family
  • Versions 24 and later
    HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
    New in version 24
    HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
    HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
    New in version 24
    HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
    HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
    New in version 24
    HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
    HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
  • Versions 24 and later
    HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
    New in version 24
    HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
    HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
  • Versions 24 and later
    HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
    New in version 24
    HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
    HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
    New in version 24
    HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
    HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_2_ALIGNE: Murmur algorithm version 2 for aligned machine: 32-bit hash result
    New in version 24
    HA_MURMUR_2_ALIGNE: Murmur algorithm version 2 for aligned machine: 32-bit hash result
    HA_MURMUR_2_ALIGNE: Murmur algorithm version 2 for aligned machine: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
    New in version 24
    HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
    HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
    New in version 24
    HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
    HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
  • Versions 24 and later
    HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
    New in version 24
    HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
    HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
AndroidAndroid Widget The constants of this family are not available.

Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
RIPEMD family
  • HA_RIPEMD_128
  • HA_RIPEMD_160
AndroidAndroid Widget The constants of this family are not available.
Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
SHA family
  • HA_SHA_160 (also called SHA-1)
  • HA_SHA_256 (FIPS PUB 198 specifications)
  • Versions 25 and later
    HA_SHA_256_DOUBLE
    New in version 25
    HA_SHA_256_DOUBLE
    HA_SHA_256_DOUBLE
  • HA_SHA_384
  • HA_SHA_512
Versions 23 and later
SHA-3 family
New in version 23
SHA-3 family
SHA-3 family
  • Versions 23 and later
    HA_SHA3_224
    New in version 23
    HA_SHA3_224
    HA_SHA3_224
  • Versions 23 and later
    HA_SHA3_256
    New in version 23
    HA_SHA3_256
    HA_SHA3_256
  • Versions 23 and later
    HA_SHA3_384
    New in version 23
    HA_SHA3_384
    HA_SHA3_384
  • Versions 23 and later
    HA_SHA3_512
    New in version 23
    HA_SHA3_512
    HA_SHA3_512
AndroidAndroid Widget The constants of this family are not available.

Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
TIGER family
  • HA_TIGER_128
  • HA_TIGER_160
  • HA_TIGER_192
AndroidAndroid Widget The constants of this family are not available.
Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
WHIRLPOOL familyHA_WHIRLPOOL
AndroidAndroid Widget Not available.
Versions 26 and later
AndroidAndroid Widget This constant is now available.
New in version 26
AndroidAndroid Widget This constant is now available.
AndroidAndroid Widget This constant is now available.
CKSUM family
  • HA_CKSUM_8
  • HA_CKSUM_16
  • HA_CKSUM_32
  • HA_CKSUM_64
AndroidAndroid Widget The constants of this family are not available.
Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
  • MD4 / MD5 / SHA / RIPEMD algorithms: standard cryptographic hash functions.
  • TIGER/WHIRLPOOL algorithms: hash functions with high cryptographic properties optimized for the 64-bit mode (but can also be used in 32-bit mode).
  • CKSUM algorithms: hash functions with no cryptographic property, should be used to perform low-level checks or with hashing tables.
  • Versions 24 and later
    MURMUR algorithm: very fast hash functions with no cryptographic properties. This algorithm is used by the "bloom filter" of bitcoin wallets.
    New in version 24
    MURMUR algorithm: very fast hash functions with no cryptographic properties. This algorithm is used by the "bloom filter" of bitcoin wallets.
    MURMUR algorithm: very fast hash functions with no cryptographic properties. This algorithm is used by the "bloom filter" of bitcoin wallets.
<File path>: Character string
Path of file on which the calculation will be performed.
<Progress Bar>: Optional window name or optional control name
Versions 24 and later
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
New in version 24
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.

Calculating a hash with message authentication (HMAC/MURMUR algorithm) Hide the details

<Result> = HashFile(<Type of algorithm> , <File path> , <Secret key> [, <Progress Bar>])
<Result>: Buffer
Result of <File path> hashing with the <Type of algorithm> algorithm.
Caution: This result may contain non-displayable characters.
<Type of algorithm>: Integer constant
Indicates the type of HMAC algorithm used when hashing the <File path> file:
Versions 25 and later
MD4 family
New in version 25
MD4 family
MD4 family
Versions 25 and later
HA_HMAC_MD4

AndroidAndroid Widget Not available.
New in version 25
HA_HMAC_MD4

AndroidAndroid Widget Not available.
HA_HMAC_MD4

AndroidAndroid Widget Not available.
Versions 26 and later
AndroidAndroid Widget This constant is now available.
New in version 26
AndroidAndroid Widget This constant is now available.
AndroidAndroid Widget This constant is now available.
MD5 familyHA_HMAC_MD5_128
Versions 24 and later
MURMUR family
New in version 24
MURMUR family
MURMUR family
  • Versions 24 and later
    HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
    New in version 24
    HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
    HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
    New in version 24
    HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
    HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
    New in version 24
    HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
    HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
  • Versions 24 and later
    HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
    New in version 24
    HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
    HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
  • Versions 24 and later
    HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
    New in version 24
    HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
    HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
    New in version 24
    HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
    HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_2_ALIGNE: Murmur algorithm version 2 for aligned machine: 32-bit hash result
    New in version 24
    HA_MURMUR_2_ALIGNE: Murmur algorithm version 2 for aligned machine: 32-bit hash result
    HA_MURMUR_2_ALIGNE: Murmur algorithm version 2 for aligned machine: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
    New in version 24
    HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
    HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
  • Versions 24 and later
    HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
    New in version 24
    HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
    HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
  • Versions 24 and later
    HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
    New in version 24
    HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
    HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
AndroidAndroid Widget The constants of this family are not available.

Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
RIPEMD family
  • HA_HMAC_RIPEMD_128
  • HA_HMAC_RIPEMD_160
AndroidAndroid Widget The constants of this family are not available.
Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
SHA family
  • HA_HMAC_SHA_160
  • HA_HMAC_SHA_256
  • Versions 25 and later
    HA_HMAC_SHA_256_DOUBLE
    New in version 25
    HA_HMAC_SHA_256_DOUBLE
    HA_HMAC_SHA_256_DOUBLE
  • HA_HMAC_SHA_384
  • HA_HMAC_SHA_512
Versions 23 and later
SHA-3 family
New in version 23
SHA-3 family
SHA-3 family
  • Versions 23 and later
    HA_HMAC_SHA3_224
    New in version 23
    HA_HMAC_SHA3_224
    HA_HMAC_SHA3_224
  • Versions 23 and later
    HA_HMAC_SHA3_256
    New in version 23
    HA_HMAC_SHA3_256
    HA_HMAC_SHA3_256
  • Versions 23 and later
    HA_HMAC_SHA3_384
    New in version 23
    HA_HMAC_SHA3_384
    HA_HMAC_SHA3_384
  • Versions 23 and later
    HA_HMAC_SHA3_512
    New in version 23
    HA_HMAC_SHA3_512
    HA_HMAC_SHA3_512
AndroidAndroid Widget The constants of this family are not available.

Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
TIGER family
  • HA_HMAC_TIGER_128
  • HA_HMAC_TIGER_160
  • HA_HMAC_TIGER_192
AndroidAndroid Widget The constants of this family are not available.
Versions 26 and later
AndroidAndroid Widget The constants of this family are now available.
New in version 26
AndroidAndroid Widget The constants of this family are now available.
AndroidAndroid Widget The constants of this family are now available.
WHIRLPOOL familyHA_HMAC_WHIRLPOOL
AndroidAndroid Widget Not available.
Versions 26 and later
AndroidAndroid Widget This constant is now available.
New in version 26
AndroidAndroid Widget This constant is now available.
AndroidAndroid Widget This constant is now available.
  • MD4 / MD5 / SHA / RIPEMD algorithms: standard cryptographic hash functions.
  • TIGER/WHIRLPOOL algorithms: hash functions with high cryptographic properties optimized for the 64-bit mode (but can also be used in 32-bit mode).
  • Versions 24 and later
    MURMUR algorithm: very fast hash functions with no cryptographic properties. This algorithm is used by the "bloom filter" of bitcoin wallets.
    New in version 24
    MURMUR algorithm: very fast hash functions with no cryptographic properties. This algorithm is used by the "bloom filter" of bitcoin wallets.
    MURMUR algorithm: very fast hash functions with no cryptographic properties. This algorithm is used by the "bloom filter" of bitcoin wallets.
<File path>: Character string
Path of file on which the calculation will be performed.
<Secret key>: Character string or Integer
Authentication key of message.
  • If an HMAC algorithm is used, this parameter must be a string.
  • Versions 24 and later
    If a MURMUR algorithm is used, the key must be an integer.
    New in version 24
    If a MURMUR algorithm is used, the key must be an integer.
    If a MURMUR algorithm is used, the key must be an integer.
AndroidAndroid Widget This parameter must not be an empty string.
<Progress Bar>: Optional control name or optional window name
Versions 24 and later
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
New in version 24
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
Versions 27 and later
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst

Calculating a hash using a key derivation function that takes a salt as parameter (PBKDF2) Hide the details

<Result> = HashFile(<Type of algorithm> , <File path> , <Salt> , <Iteration> , <Length> [, <Progress Bar>])
<Result>: Buffer
Result of <File path> hashing with the <Type of algorithm> algorithm.
Caution: This result may contain non-displayable characters.
<Type of algorithm>: Integer constant
Indicates the type of pseudo-random algorithm used by PBKDF2 to hash the <File path> file:
MD4 familyHA_PBKDF2_HMAC_MD4
MD5 familyHA_PBKDF2_HMAC_MD5_128
RIPEMD family
  • HA_PBKDF2_HMAC_RIPEMD_128
  • HA_PBKDF2_HMAC_RIPEMD_160
SHA family
  • HA_PBKDF2_HMAC_SHA_160
  • HA_PBKDF2_HMAC_SHA_256
  • HA_PBKDF2_HMAC_SHA_256_DOUBLE
  • HA_PBKDF2_HMAC_SHA_384
  • HA_PBKDF2_HMAC_SHA_512
SHA-3 family
  • HA_PBKDF2_HMAC_SHA3_224
  • HA_PBKDF2_HMAC_SHA3_256
  • HA_PBKDF2_HMAC_SHA3_384
  • HA_PBKDF2_HMAC_SHA3_512
TIGER family
  • HA_PBKDF2_HMAC_TIGER_128
  • HA_PBKDF2_HMAC_TIGER_160
  • HA_PBKDF2_HMAC_TIGER_192
WHIRLPOOL familyHA_PBKDF2_HMAC_WHIRLPOOL
  • MD4 / MD5 / SHA / RIPEMD algorithms: standard cryptographic hash functions.
  • TIGER/WHIRLPOOL algorithms: hash functions with high cryptographic properties optimized for the 64-bit mode (but can also be used in 32-bit mode).
<File path>: Character string
Path of file on which the calculation will be performed.
<Salt>: Character string
Cryptographic salt used. String (usually random) added to the file to make it more complex.
<Iteration>: Integer
Number of iterations of the algorithm (10000 by default). This number depends on the power of the computing machine and the complexity of the hash. A minimum of 1000 iterations is generally recommended.
<Length>: Integer
Length of the derived key. By default, corresponds to the size of the key generated by the pseudo-random algorithm. This length is technically unbounded but due to the algorithm, it is limited to (2^32 - 1) * (output length of the algorithm used by PBKDF2).
<Progress Bar>: Optional window name or optional control name
Versions 24 and later
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
New in version 24
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
New in version 27
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst

Calculating a hash using a key derivation function that takes a salt as parameter (PBKDF2) Hide the details

<Result> = HashFile(<Type of algorithm> , <File path> , <Salt> , <Iteration> , <Length> [, <Progress Bar>])
<Result>: Buffer
Result of <File path> hashing with the <Type of algorithm> algorithm.
Caution: This result may contain non-displayable characters.
<Type of algorithm>: Integer constant
Indicates the type of pseudo-random algorithm used by PBKDF2 to hash the <File path> file:
MD4 familyHA_PBKDF2_HMAC_MD4
MD5 familyHA_PBKDF2_HMAC_MD5_128
RIPEMD family
  • HA_PBKDF2_HMAC_RIPEMD_128
  • HA_PBKDF2_HMAC_RIPEMD_160
SHA family
  • HA_PBKDF2_HMAC_SHA_160
  • HA_PBKDF2_HMAC_SHA_256
  • HA_PBKDF2_HMAC_SHA_256_DOUBLE
  • HA_PBKDF2_HMAC_SHA_384
  • HA_PBKDF2_HMAC_SHA_512
SHA-3 family
  • HA_PBKDF2_HMAC_SHA3_224
  • HA_PBKDF2_HMAC_SHA3_256
  • HA_PBKDF2_HMAC_SHA3_384
  • HA_PBKDF2_HMAC_SHA3_512
TIGER family
  • HA_PBKDF2_HMAC_TIGER_128
  • HA_PBKDF2_HMAC_TIGER_160
  • HA_PBKDF2_HMAC_TIGER_192
WHIRLPOOL familyHA_PBKDF2_HMAC_WHIRLPOOL
  • MD4 / MD5 / SHA / RIPEMD algorithms: standard cryptographic hash functions.
  • TIGER/WHIRLPOOL algorithms: hash functions with high cryptographic properties optimized for the 64-bit mode (but can also be used in 32-bit mode).
<File path>: Character string
Path of file on which the calculation will be performed.
<Salt>: Character string
Cryptographic salt used. String (usually random) added to the file to make it more complex.
<Iteration>: Integer
Number of iterations of the algorithm (10000 by default). This number depends on the power of the computing machine and the complexity of the hash. A minimum of 1000 iterations is generally recommended.
<Length>: Integer
Length of the derived key. By default, corresponds to the size of the key generated by the pseudo-random algorithm. This length is technically unbounded but due to the algorithm, it is limited to (2^32 - 1) * (output length of the algorithm used by PBKDF2).
<Progress Bar>: Optional window name or optional control name
Versions 24 and later
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
New in version 24
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst

Calculating a hash using a key derivation function that takes a salt as parameter (PBKDF2) Hide the details

<Result> = HashFile(<Type of algorithm> , <File path> , <Salt> , <Iteration> , <Length> [, <Progress Bar>])
<Result>: Buffer
Result of <File path> hashing with the <Type of algorithm> algorithm.
Caution: This result may contain non-displayable characters.
<Type of algorithm>: Integer constant
Indicates the type of pseudo-random algorithm used by PBKDF2 to hash the <File path> file:
MD4 familyHA_PBKDF2_HMAC_MD4
MD5 familyHA_PBKDF2_HMAC_MD5_128
RIPEMD family
  • HA_PBKDF2_HMAC_RIPEMD_128
  • HA_PBKDF2_HMAC_RIPEMD_160
SHA family
  • HA_PBKDF2_HMAC_SHA_160
  • HA_PBKDF2_HMAC_SHA_256
  • HA_PBKDF2_HMAC_SHA_256_DOUBLE
  • HA_PBKDF2_HMAC_SHA_384
  • HA_PBKDF2_HMAC_SHA_512
SHA-3 family
  • HA_PBKDF2_HMAC_SHA3_224
  • HA_PBKDF2_HMAC_SHA3_256
  • HA_PBKDF2_HMAC_SHA3_384
  • HA_PBKDF2_HMAC_SHA3_512
TIGER family
  • HA_PBKDF2_HMAC_TIGER_128
  • HA_PBKDF2_HMAC_TIGER_160
  • HA_PBKDF2_HMAC_TIGER_192
WHIRLPOOL familyHA_PBKDF2_HMAC_WHIRLPOOL
  • MD4 / MD5 / SHA / RIPEMD algorithms: standard cryptographic hash functions.
  • TIGER/WHIRLPOOL algorithms: hash functions with high cryptographic properties optimized for the 64-bit mode (but can also be used in 32-bit mode).
<File path>: Character string
Path of file on which the calculation will be performed.
<Salt>: Character string
Cryptographic salt used. String (usually random) added to the file to make it more complex.
<Iteration>: Integer
Number of iterations of the algorithm (10000 by default). This number depends on the power of the computing machine and the complexity of the hash. A minimum of 1000 iterations is generally recommended.
<Length>: Integer
Length of the derived key. By default, corresponds to the size of the key generated by the pseudo-random algorithm. This length is technically unbounded but due to the algorithm, it is limited to (2^32 - 1) * (output length of the algorithm used by PBKDF2).
<Progress Bar>: Optional window name or optional control name
Versions 24 and later
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
New in version 24
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
Universal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
Remarks

Notes

  • Two files with an identical content will have, for the same type of algorithm, two identical Hashes.
  • The result of the Hash may contain non-displayable characters. These characters will not be visible when using Info or Trace for example.
Related Examples:
The Hash functions Unit examples (WINDEV): The Hash functions
[ + ] Using the hashing functions.
The HashFile and HashString functions are used to calculate a Hash key for a string or for a file.
This Hash key is used to:
- Check whether the file is consistent after a transfer for example
- Find file duplicates
- ...
Business / UI classification: Business Logic
Component: wd270com.dll
Minimum version required
  • Version 11
This page is also available for…
Comments
Click [Add] to post a comment