HashFile (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Availability of algorithms

Related examples

See also

HashFile (Function)

In french: HashFichier

Calculates the Hash of a file according to a specific algorithm. You have the ability to calculate:

a simple hash.
a hash with message authentication.

Reminder: The hashing is used to summarize a file or a character string. This summary is called Hash.

Versions 15 and later

This function is now available for the PHP sites.

This function is now available for the Java applications.

This function is now available for Android applications.

New in version 15

This function is now available for the PHP sites.

This function is now available for the Java applications.

This function is now available for Android applications.

This function is now available for the PHP sites.

This function is now available for the Java applications.

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

New in version 18

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget 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

// Calculate the Hash of two files
Hash1 is Buffer = HashFile(HA_MD5_128, "C:\My files\FileA.txt")
Hash2 is Buffer = HashFile(HA_MD5_128, "D:\My files\FileB.txt")
// Compare the two Hash
IF Hash1 = Hash2 THEN Info("The two files are identical.")

// Calculate the Hash of two files
Hash1 is Buffer = HashFile(HA_MD5_128, "\My files\FileA.txt")
Hash2 is Buffer = HashFile(HA_MD5_128, "\My files\FileB.txt")
// Compare the two Hash
IF Hash1 = Hash2 THEN Info("The two files are identical.")

Syntax

Calculating a simple hash Hide the details

<Result> = HashFile(<Type of Algorithm> , <File path>)

<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:
MD5 family HA_MD5_128
Versions 24 and later
MURMUR family
(Multiply Rotate)
New in version 24
MURMUR family
(Multiply Rotate)
MURMUR family
(Multiply Rotate)
Versions 24 and later
HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
Not available.
HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
Not available.
HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
Not available.
New in version 24
HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
Not available.
HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
Not available.
Versions 24 and later
HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
Not available.
New in version 24
HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
Not available.
HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
Not available.
Versions 24 and later
HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
Not available.
HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
Not available.
HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_2_ALIGNED: Murmur algorithm version 2 for aligned machine: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_2_ALIGNED: Murmur algorithm version 2 for aligned machine: 32-bit hash result
Not available.
HA_MURMUR_2_ALIGNED: Murmur algorithm version 2 for aligned machine: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
Not available.
HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
Not available.
New in version 24
HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
Not available.
HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
Not available.
Versions 24 and later
HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
Not available.
New in version 24
HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
Not available.
HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
Not available.
SHA family HA_SHA_160 (also called SHA-1)
HA_SHA_256
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
Not available.
New in version 23
HA_SHA3_224
Not available.
HA_SHA3_224
Not available.
Versions 23 and later
HA_SHA3_256
Not available.
New in version 23
HA_SHA3_256
Not available.
HA_SHA3_256
Not available.
Versions 23 and later
HA_SHA3_384
Not available.
New in version 23
HA_SHA3_384
Not available.
HA_SHA3_384
Not available.
Versions 23 and later
HA_SHA3_512
Not available.
New in version 23
HA_SHA3_512
Not available.
HA_SHA3_512
Not available.
RIPEMD family HA_RIPEMD_128
Not available.
HA_RIPEMD_160
Not available.
TIGER family HA_TIGER_128
Not available.
Not available.
HA_TIGER_160
Not available.
Not available.
HA_TIGER_192
Not available.
Not available.
WHIRLPOOL family HA_WHIRLPOOL
Not available.
CKSUM family HA_CKSUM_8
Not available.
HA_CKSUM_16
Not available.
HA_CKSUM_32
Not available.
HA_CKSUM_64
Not available.
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).
The TIGER algorithms are not available.
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 (Multiply Rotate): very fast hashing functions. This algorithm is used by the "bloom filter" of bitcoin wallets.
New in version 24
MURMUR algorithm (Multiply Rotate): very fast hashing functions. This algorithm is used by the "bloom filter" of bitcoin wallets.
MURMUR algorithm (Multiply Rotate): very fast hashing functions. This algorithm is used by the "bloom filter" of bitcoin wallets.

<File path>: Character string (with quotes)

Path of file on which the calculation will be performed.

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

<Result> = HashFile(<Type of Algorithm> , <File path> , <Secret Key>)

<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:
MD5 family HA_HMAC_MD5_128
Versions 24 and later
MURMUR family
(Multiply Rotate)
New in version 24
MURMUR family
(Multiply Rotate)
MURMUR family
(Multiply Rotate)
Versions 24 and later
HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
Not available.
HA_MURMUR_1: Murmur algorithm version 1: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
Not available.
HA_MURMUR_2: Murmur algorithm version 2: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
Not available.
New in version 24
HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
Not available.
HA_MURMUR_2_64A: Murmur algorithm version 2: 64-bit hash result optimized for 64-bit processors
Not available.
Versions 24 and later
HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
Not available.
New in version 24
HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
Not available.
HA_MURMUR_2_64B: Murmur algorithm version 2: 64-bit hash result optimized for 32-bit processors
Not available.
Versions 24 and later
HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
Not available.
HA_MURMUR_2_A: Incremental Murmur algorithm version 2: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
Not available.
HA_MURMUR_2_BIG_ENDIAN: Murmur algorithm version 2 for big-endian machine: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_2_ALIGNED: Murmur algorithm version 2 for aligned machine: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_2_ALIGNED: Murmur algorithm version 2 for aligned machine: 32-bit hash result
Not available.
HA_MURMUR_2_ALIGNED: Murmur algorithm version 2 for aligned machine: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
Not available.
New in version 24
HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
Not available.
HA_MURMUR_3_32: Murmur algorithm version 3: 32-bit hash result
Not available.
Versions 24 and later
HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
Not available.
New in version 24
HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
Not available.
HA_MURMUR_3_128_X86: Murmur algorithm version 3: 128-bit hash result optimized for 32-bit processors
Not available.
Versions 24 and later
HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
Not available.
New in version 24
HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
Not available.
HA_MURMUR_3_128_X64: Murmur algorithm version 3: 128-bit hash result optimized for 64-bit processors
Not available.
SHA family HA_HMAC_SHA_160
HA_HMAC_SHA_256
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_SHA3_224
Not available.
New in version 23
HA_SHA3_224
Not available.
HA_SHA3_224
Not available.
Versions 23 and later
HA_SHA3_256
Not available.
New in version 23
HA_SHA3_256
Not available.
HA_SHA3_256
Not available.
Versions 23 and later
HA_SHA3_384
Not available.
New in version 23
HA_SHA3_384
Not available.
HA_SHA3_384
Not available.
Versions 23 and later
HA_SHA3_512
Not available.
New in version 23
HA_SHA3_512
Not available.
HA_SHA3_512
Not available.
RIPEMD family HA_HMAC_RIPEMD_128
Not available.
HA_HMAC_RIPEMD_160
Not available.
TIGER family HA_HMAC_TIGER_128
Not available.
Not available.
HA_HMAC_TIGER_160
Not available.
Not available.
HA_HMAC_TIGER_192
Not available.
Not available.
WHIRLPOOL family HA_HMAC_WHIRLPOOL
Not available.
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).
The TIGER algorithms are not available.
Versions 24 and later
MURMUR algorithm (Multiply Rotate): very fast hashing functions. This algorithm is used by the "bloom filter" of bitcoin wallets.
New in version 24
MURMUR algorithm (Multiply Rotate): very fast hashing functions. This algorithm is used by the "bloom filter" of bitcoin wallets.
MURMUR algorithm (Multiply Rotate): very fast hashing functions. This algorithm is used by the "bloom filter" of bitcoin wallets.

<File path>: Character string (with quotes)

Path of file on which the calculation will be performed.

<Secret Key>: Character string (between quotes) 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.
This parameter must not be an empty string.

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.

Availability of algorithms

The available algorithms depend on the configuration of PHP server.
The TIGER algorithms are not available.The SHA-3 algorithms are not available.

Only the following algorithms are supported:

HA_MD5_128
HA_SHA_160, HA_SHA_256, HA_SHA_384, HA_SHA_512
HA_HMAC_MD5_128
HA_ HMAC_SHA_160, HA_HMAC_SHA_256, HA_HMAC_SHA_384, HA_SHA_HMAC_512.

Related Examples:

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
- ...

Component : wd240com.dll